Top Description Fields Methods
com.jogamp.opencl.llb

public Interface CLImageBinding

extends CLMemObjBinding
Known Direct Subinterfaces
com.jogamp.opencl.llb.CL
Imports
com.jogamp.opencl.llb.impl.CLImageFormatImpl, com.jogamp.gluegen.runtime.*, com.jogamp.common.os.*, com.jogamp.common.nio.*, java.nio.*
Java bindings to OpenCL images.
Author
Michael Bien, GlueGen, et al.

Field Summary

Modifier and TypeField and Description
public static final int
CL_A

CType: int

public static final int
CL_ARGB

CType: int

public static final int
CL_BGRA

CType: int

public static final int
CL_FLOAT

CType: int

public static final int
CL_HALF_FLOAT

CType: int

public static final int
CL_IMAGE_DEPTH

CType: int

public static final int
CL_IMAGE_ELEMENT_SIZE

CType: int

public static final int
CL_IMAGE_FORMAT

CType: int

public static final int
CL_IMAGE_FORMAT_MISMATCH

CType: int

public static final int
CL_IMAGE_FORMAT_NOT_SUPPORTED

CType: int

public static final int
CL_IMAGE_HEIGHT

CType: int

public static final int
CL_IMAGE_ROW_PITCH

CType: int

public static final int
CL_IMAGE_SLICE_PITCH

CType: int

public static final int
CL_IMAGE_WIDTH

CType: int

public static final int
CL_INTENSITY

CType: int

public static final int
CL_LUMINANCE

CType: int

public static final int
CL_R

CType: int

public static final int
CL_RA

CType: int

public static final int
CL_RG

CType: int

public static final int
CL_RGB

CType: int

public static final int
CL_RGBA

CType: int

public static final int
CL_RGBx

CType: int

public static final int
CL_RGx

CType: int

public static final int
CL_Rx

CType: int

public static final int
CL_SIGNED_INT16

CType: int

public static final int
CL_SIGNED_INT32

CType: int

public static final int
CL_SIGNED_INT8

CType: int

public static final int
CL_SNORM_INT16

CType: int

public static final int
CL_SNORM_INT8

CType: int

public static final int
CL_UNORM_INT16

CType: int

public static final int
CL_UNORM_INT8

CType: int

public static final int
CL_UNORM_INT_101010

CType: int

public static final int
CL_UNORM_SHORT_555

CType: int

public static final int
CL_UNORM_SHORT_565

CType: int

public static final int
CL_UNSIGNED_INT16

CType: int

public static final int
CL_UNSIGNED_INT32

CType: int

public static final int
CL_UNSIGNED_INT8

CType: int

Inherited from com.jogamp.opencl.llb.CLMemObjBinding:
CL_MAP_FAILURECL_MAP_READCL_MAP_WRITECL_MEM_ALLOC_HOST_PTRCL_MEM_ASSOCIATED_MEMOBJECTCL_MEM_CONTEXTCL_MEM_COPY_HOST_PTRCL_MEM_COPY_OVERLAPCL_MEM_FLAGSCL_MEM_HOST_PTRCL_MEM_MAP_COUNTCL_MEM_OBJECT_ALLOCATION_FAILURECL_MEM_OBJECT_BUFFERCL_MEM_OBJECT_IMAGE2DCL_MEM_OBJECT_IMAGE3DCL_MEM_OFFSETCL_MEM_READ_ONLYCL_MEM_READ_WRITECL_MEM_REFERENCE_COUNTCL_MEM_SIZECL_MEM_TYPECL_MEM_USE_HOST_PTRCL_MEM_WRITE_ONLY

Method Summary

Modifier and TypeMethod and Description
public long
clCreateImage2D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_row_pitch, Buffer
a direct or array-backed java.nio.Buffer
host_ptr, IntBuffer
a direct or array-backed java.nio.IntBuffer
errcode_ret)

Interface to C language function: cl_mem {@native clCreateImage2D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_row_pitch, void * host_ptr, cl_int * errcode_ret)

public long
clCreateImage2D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_row_pitch, Buffer
a direct or array-backed java.nio.Buffer
host_ptr, int[] errcode_ret, int errcode_ret_offset)

Interface to C language function: cl_mem {@native clCreateImage2D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_row_pitch, void * host_ptr, cl_int * errcode_ret)

public long
clCreateImage3D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Buffer
a direct or array-backed java.nio.Buffer
host_ptr, IntBuffer
a direct or array-backed java.nio.IntBuffer
errcode_ret)

Interface to C language function: cl_mem {@native clCreateImage3D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_depth, size_t image_row_pitch, size_t image_slice_pitch, void * host_ptr, cl_int * errcode_ret)

public long
clCreateImage3D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Buffer
a direct or array-backed java.nio.Buffer
host_ptr, int[] errcode_ret, int errcode_ret_offset)

Interface to C language function: cl_mem {@native clCreateImage3D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_depth, size_t image_row_pitch, size_t image_slice_pitch, void * host_ptr, cl_int * errcode_ret)

public int
clGetImageInfo(long image, int param_name, long param_value_size, Buffer
a direct only java.nio.Buffer
param_value, PointerBuffer
a direct only com.jogamp.common.nio.PointerBuffer
param_value_size_ret)

Interface to C language function: cl_int {@native clGetImageInfo}(cl_mem image, cl_image_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret)

Inherited from com.jogamp.opencl.llb.CLMemObjBinding:
clGetMemObjectInfoclReleaseMemObjectclRetainMemObjectclSetMemObjectDestructorCallback

Field Detail

CL_Aback to summary
public static final int CL_A

CType: int

CL_ARGBback to summary
public static final int CL_ARGB

CType: int

CL_BGRAback to summary
public static final int CL_BGRA

CType: int

CL_FLOATback to summary
public static final int CL_FLOAT

CType: int

CL_HALF_FLOATback to summary
public static final int CL_HALF_FLOAT

CType: int

CL_IMAGE_DEPTHback to summary
public static final int CL_IMAGE_DEPTH

CType: int

CL_IMAGE_ELEMENT_SIZEback to summary
public static final int CL_IMAGE_ELEMENT_SIZE

CType: int

CL_IMAGE_FORMATback to summary
public static final int CL_IMAGE_FORMAT

CType: int

CL_IMAGE_FORMAT_MISMATCHback to summary
public static final int CL_IMAGE_FORMAT_MISMATCH

CType: int

CL_IMAGE_FORMAT_NOT_SUPPORTEDback to summary
public static final int CL_IMAGE_FORMAT_NOT_SUPPORTED

CType: int

CL_IMAGE_HEIGHTback to summary
public static final int CL_IMAGE_HEIGHT

CType: int

CL_IMAGE_ROW_PITCHback to summary
public static final int CL_IMAGE_ROW_PITCH

CType: int

CL_IMAGE_SLICE_PITCHback to summary
public static final int CL_IMAGE_SLICE_PITCH

CType: int

CL_IMAGE_WIDTHback to summary
public static final int CL_IMAGE_WIDTH

CType: int

CL_INTENSITYback to summary
public static final int CL_INTENSITY

CType: int

CL_LUMINANCEback to summary
public static final int CL_LUMINANCE

CType: int

CL_Rback to summary
public static final int CL_R

CType: int

CL_RAback to summary
public static final int CL_RA

CType: int

CL_RGback to summary
public static final int CL_RG

CType: int

CL_RGBback to summary
public static final int CL_RGB

CType: int

CL_RGBAback to summary
public static final int CL_RGBA

CType: int

CL_RGBxback to summary
public static final int CL_RGBx

CType: int

CL_RGxback to summary
public static final int CL_RGx

CType: int

CL_Rxback to summary
public static final int CL_Rx

CType: int

CL_SIGNED_INT16back to summary
public static final int CL_SIGNED_INT16

CType: int

CL_SIGNED_INT32back to summary
public static final int CL_SIGNED_INT32

CType: int

CL_SIGNED_INT8back to summary
public static final int CL_SIGNED_INT8

CType: int

CL_SNORM_INT16back to summary
public static final int CL_SNORM_INT16

CType: int

CL_SNORM_INT8back to summary
public static final int CL_SNORM_INT8

CType: int

CL_UNORM_INT16back to summary
public static final int CL_UNORM_INT16

CType: int

CL_UNORM_INT8back to summary
public static final int CL_UNORM_INT8

CType: int

CL_UNORM_INT_101010back to summary
public static final int CL_UNORM_INT_101010

CType: int

CL_UNORM_SHORT_555back to summary
public static final int CL_UNORM_SHORT_555

CType: int

CL_UNORM_SHORT_565back to summary
public static final int CL_UNORM_SHORT_565

CType: int

CL_UNSIGNED_INT16back to summary
public static final int CL_UNSIGNED_INT16

CType: int

CL_UNSIGNED_INT32back to summary
public static final int CL_UNSIGNED_INT32

CType: int

CL_UNSIGNED_INT8back to summary
public static final int CL_UNSIGNED_INT8

CType: int

Method Detail

clCreateImage2Dback to summary
public long clCreateImage2D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_row_pitch, Buffer host_ptr, IntBuffer errcode_ret)

Interface to C language function:
cl_mem {@native clCreateImage2D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_row_pitch, void * host_ptr, cl_int * errcode_ret)

Parameters
host_ptr:Buffer

a direct or array-backed java.nio.Buffer

errcode_ret:IntBuffer

a direct or array-backed java.nio.IntBuffer

clCreateImage2Dback to summary
public long clCreateImage2D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_row_pitch, Buffer host_ptr, int[] errcode_ret, int errcode_ret_offset)

Interface to C language function:
cl_mem {@native clCreateImage2D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_row_pitch, void * host_ptr, cl_int * errcode_ret)

Parameters
host_ptr:Buffer

a direct or array-backed java.nio.Buffer

clCreateImage3Dback to summary
public long clCreateImage3D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Buffer host_ptr, IntBuffer errcode_ret)

Interface to C language function:
cl_mem {@native clCreateImage3D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_depth, size_t image_row_pitch, size_t image_slice_pitch, void * host_ptr, cl_int * errcode_ret)

Parameters
host_ptr:Buffer

a direct or array-backed java.nio.Buffer

errcode_ret:IntBuffer

a direct or array-backed java.nio.IntBuffer

clCreateImage3Dback to summary
public long clCreateImage3D(long context, long flags, CLImageFormatImpl image_format, long image_width, long image_height, long image_depth, long image_row_pitch, long image_slice_pitch, Buffer host_ptr, int[] errcode_ret, int errcode_ret_offset)

Interface to C language function:
cl_mem {@native clCreateImage3D}(cl_context context, cl_mem_flags flags, const cl_image_format * image_format, size_t image_width, size_t image_height, size_t image_depth, size_t image_row_pitch, size_t image_slice_pitch, void * host_ptr, cl_int * errcode_ret)

Parameters
host_ptr:Buffer

a direct or array-backed java.nio.Buffer

clGetImageInfoback to summary
public int clGetImageInfo(long image, int param_name, long param_value_size, Buffer param_value, PointerBuffer param_value_size_ret)

Interface to C language function:
cl_int {@native clGetImageInfo}(cl_mem image, cl_image_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret)

Parameters
param_value:Buffer

a direct only java.nio.Buffer

param_value_size_ret:PointerBuffer

a direct only com.jogamp.common.nio.PointerBuffer