Package org.jocl
Class cl_image_desc
- java.lang.Object
-
- org.jocl.cl_image_desc
-
public class cl_image_desc extends java.lang.Object
Java port of a cl_image_desc
-
-
Field Summary
Fields Modifier and Type Field Description cl_mem
buffer
buffer refers to a valid buffer memory object if image_type is CL_MEM_OBJECT_IMAGE1D_BUFFER.long
image_array_size
The number of images in the image array.long
image_depth
The depth of the image in pixels.long
image_height
Height of the image in pixels.long
image_row_pitch
The scan-line pitch in bytes.long
image_slice_pitch
The size in bytes of each 2D slice in the 3D image or the size in bytes of each image in a 1D or 2D image array.int
image_type
Describes the image type.long
image_width
The width of the image in pixels.int
num_mip_levels
Must be 0.int
num_samples
Must be 0.
-
Constructor Summary
Constructors Constructor Description cl_image_desc()
Creates a new, uninitialized cl_image_desc
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
Returns a String representation of this object.
-
-
-
Field Detail
-
image_type
public int image_type
Describes the image type. This is acl_mem_object_type
and must be either CL_MEM_OBJECT_IMAGE1D, CL_MEM_OBJECT_IMAGE1D_BUFFER, CL_MEM_OBJECT_IMAGE1D_ARRAY, CL_MEM_OBJECT_IMAGE2D, CL_MEM_OBJECT_IMAGE2D_ARRAY or CL_MEM_OBJECT_IMAGE3D.
-
image_width
public long image_width
The width of the image in pixels. For a 2D image and image array, the image width must be <= CL_DEVICE_IMAGE2D_MAX_WIDTH. For a 3D image, the image width must be <= CL_DEVICE_IMAGE3D_MAX_WIDTH. For a 1D image buffer, the image width must be <= CL_DEVICE_IMAGE_MAX_BUFFER_SIZE. For a 1D image and 1D image array, the image width must be <= CL_DEVICE_IMAGE2D_MAX_WIDTH.
-
image_height
public long image_height
Height of the image in pixels. This is only used if the image is a 2D, 3D or 2D image array. For a 2D image or image array, the image height must be <= CL_DEVICE_IMAGE2D_MAX_HEIGHT. For a 3D image, the image height must be <= CL_DEVICE_IMAGE3D_MAX_HEIGHT.
-
image_depth
public long image_depth
The depth of the image in pixels. This is only used if the image is a 3D image and must be a value >= 1 and <= CL_DEVICE_IMAGE3D_MAX_DEPTH.
-
image_array_size
public long image_array_size
The number of images in the image array. This is only used if the image is a 1D or 2D image array. The values for image_array_size, if specified, must be a value >= 1 and <= CL_DEVICE_IMAGE_MAX_ARRAY_SIZE.
-
image_row_pitch
public long image_row_pitch
The scan-line pitch in bytes. This must be 0 if host_ptr is NULL and can be either 0 or >= image_width * size of element in bytes if host_ptr is not NULL. If host_ptr is not NULL and image_row_pitch = 0, image_row_pitch is calculated as image_width * size of element in bytes. If image_row_pitch is not 0, it must be a multiple of the image element size in bytes
-
image_slice_pitch
public long image_slice_pitch
The size in bytes of each 2D slice in the 3D image or the size in bytes of each image in a 1D or 2D image array. This must be 0 if host_ptr is NULL. If host_ptr is not NULL, image_slice_pitch can be either 0 or >= image_row_pitch * image_height for a 2D image array or 3D image and can be either 0 or >= image_row_pitch for a 1D image array. If host_ptr is not NULL and image_slice_pitch = 0, image_slice_pitch is calculated as image_row_pitch * image_height for a 2D image array or 3D image and image_row_pitch for a 1D image array. If image_slice_pitch is not 0, it must be a multiple of the image_row_pitch
-
num_mip_levels
public int num_mip_levels
Must be 0.
-
num_samples
public int num_samples
Must be 0.
-
buffer
public cl_mem buffer
buffer refers to a valid buffer memory object if image_type is CL_MEM_OBJECT_IMAGE1D_BUFFER. Otherwise it must be NULL. For a 1D image buffer object, the image pixels are taken from the buffer object's data store. When the contents of a buffer object's data store are modified, those changes are reflected in the contents of the 1D image buffer object and vice-versa at corresponding synchronization points. The image_width * size of element in bytes must be <= size of buffer object data store.
-
-