write_imageh (3D)

Write color value to location in the 3D image object.

void write_imageh ( image3d_t image,
  int4 coord,
  half4 color)

Description

Write color value to location specified by coordinate (x, y, z) in the 3D image object specified by image. Appropriate data format conversion to the specified image format is done before writing the color value. coord.x, coord.y, and coord.z are considered to be unnormalized coordinates and must be in the range 0... image stream width - 1, 0... image stream height - 1 and 0... image stream width - 1.

write_imageh can only be used with image objects created with image_channel_data_type set to one of the pre-defined packed formats or set to CL_SNORM_INT8, CL_UNORM_INT8, CL_SNORM_INT16, CL_UNORM_INT16, or CL_HALF_FLOAT. Appropriate data format conversion will be done to convert channel data from a half floating-point value to actual data format in which the channels are stored.

The behavior of write_imageh for image objects created with image_channel_data_type values not specified in the description above or with (x, y,z) coordinate values that are not in the range (0... image width - 1, 0... image height - 1),0... image depth -1) respectively, is undefined.

Specification

OpenCL Specification

Also see

Image Functions

Copyright © 2007-2009 The Khronos Group Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.