com.jogamp.opencl.llb
Interface CLImageBinding

All Superinterfaces:
CLMemObjBinding
All Known Subinterfaces:
CL, CLGL
All Known Implementing Classes:
CLAbstractImpl, CLImpl

public interface CLImageBinding
extends CLMemObjBinding

Java bindings to OpenCL images.

Author:
Michael Bien, GlueGen, et al.

Field Summary
static int CL_A
           
static int CL_ARGB
           
static int CL_BGRA
           
static int CL_FLOAT
           
static int CL_HALF_FLOAT
           
static int CL_IMAGE_DEPTH
           
static int CL_IMAGE_ELEMENT_SIZE
           
static int CL_IMAGE_FORMAT
           
static int CL_IMAGE_FORMAT_MISMATCH
           
static int CL_IMAGE_FORMAT_NOT_SUPPORTED
           
static int CL_IMAGE_HEIGHT
           
static int CL_IMAGE_ROW_PITCH
           
static int CL_IMAGE_SLICE_PITCH
           
static int CL_IMAGE_WIDTH
           
static int CL_INTENSITY
           
static int CL_LUMINANCE
           
static int CL_R
           
static int CL_RA
           
static int CL_RG
           
static int CL_RGB
           
static int CL_RGBA
           
static int CL_RGBx
           
static int CL_RGx
           
static int CL_Rx
           
static int CL_SIGNED_INT16
           
static int CL_SIGNED_INT32
           
static int CL_SIGNED_INT8
           
static int CL_SNORM_INT16
           
static int CL_SNORM_INT8
           
static int CL_UNORM_INT_101010
           
static int CL_UNORM_INT16
           
static int CL_UNORM_INT8
           
static int CL_UNORM_SHORT_555
           
static int CL_UNORM_SHORT_565
           
static int CL_UNSIGNED_INT16
           
static int CL_UNSIGNED_INT32
           
static int CL_UNSIGNED_INT8
           
 
Fields inherited from interface com.jogamp.opencl.llb.CLMemObjBinding
CL_MAP_FAILURE, CL_MAP_READ, CL_MAP_WRITE, CL_MEM_ALLOC_HOST_PTR, CL_MEM_ASSOCIATED_MEMOBJECT, CL_MEM_CONTEXT, CL_MEM_COPY_HOST_PTR, CL_MEM_COPY_OVERLAP, CL_MEM_FLAGS, CL_MEM_HOST_PTR, CL_MEM_MAP_COUNT, CL_MEM_OBJECT_ALLOCATION_FAILURE, CL_MEM_OBJECT_BUFFER, CL_MEM_OBJECT_IMAGE2D, CL_MEM_OBJECT_IMAGE3D, CL_MEM_OFFSET, CL_MEM_READ_ONLY, CL_MEM_READ_WRITE, CL_MEM_REFERENCE_COUNT, CL_MEM_SIZE, CL_MEM_TYPE, CL_MEM_USE_HOST_PTR, CL_MEM_WRITE_ONLY
 
Method Summary
 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 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);
 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 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);
 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 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);
 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 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);
 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 clGetImageInfo(cl_mem image, cl_image_info param_name, size_t param_value_size, void * param_value, size_t * param_value_size_ret);
 
Methods inherited from interface com.jogamp.opencl.llb.CLMemObjBinding
clGetMemObjectInfo, clReleaseMemObject, clRetainMemObject, clSetMemObjectDestructorCallback
 

Field Detail

CL_IMAGE_FORMAT_MISMATCH

static final int CL_IMAGE_FORMAT_MISMATCH
See Also:
Constant Field Values

CL_IMAGE_FORMAT_NOT_SUPPORTED

static final int CL_IMAGE_FORMAT_NOT_SUPPORTED
See Also:
Constant Field Values

CL_R

static final int CL_R
See Also:
Constant Field Values

CL_A

static final int CL_A
See Also:
Constant Field Values

CL_RG

static final int CL_RG
See Also:
Constant Field Values

CL_RA

static final int CL_RA
See Also:
Constant Field Values

CL_RGB

static final int CL_RGB
See Also:
Constant Field Values

CL_RGBA

static final int CL_RGBA
See Also:
Constant Field Values

CL_BGRA

static final int CL_BGRA
See Also:
Constant Field Values

CL_ARGB

static final int CL_ARGB
See Also:
Constant Field Values

CL_INTENSITY

static final int CL_INTENSITY
See Also:
Constant Field Values

CL_LUMINANCE

static final int CL_LUMINANCE
See Also:
Constant Field Values

CL_Rx

static final int CL_Rx
See Also:
Constant Field Values

CL_RGx

static final int CL_RGx
See Also:
Constant Field Values

CL_RGBx

static final int CL_RGBx
See Also:
Constant Field Values

CL_SNORM_INT8

static final int CL_SNORM_INT8
See Also:
Constant Field Values

CL_SNORM_INT16

static final int CL_SNORM_INT16
See Also:
Constant Field Values

CL_UNORM_INT8

static final int CL_UNORM_INT8
See Also:
Constant Field Values

CL_UNORM_INT16

static final int CL_UNORM_INT16
See Also:
Constant Field Values

CL_UNORM_SHORT_565

static final int CL_UNORM_SHORT_565
See Also:
Constant Field Values

CL_UNORM_SHORT_555

static final int CL_UNORM_SHORT_555
See Also:
Constant Field Values

CL_UNORM_INT_101010

static final int CL_UNORM_INT_101010
See Also:
Constant Field Values

CL_SIGNED_INT8

static final int CL_SIGNED_INT8
See Also:
Constant Field Values

CL_SIGNED_INT16

static final int CL_SIGNED_INT16
See Also:
Constant Field Values

CL_SIGNED_INT32

static final int CL_SIGNED_INT32
See Also:
Constant Field Values

CL_UNSIGNED_INT8

static final int CL_UNSIGNED_INT8
See Also:
Constant Field Values

CL_UNSIGNED_INT16

static final int CL_UNSIGNED_INT16
See Also:
Constant Field Values

CL_UNSIGNED_INT32

static final int CL_UNSIGNED_INT32
See Also:
Constant Field Values

CL_HALF_FLOAT

static final int CL_HALF_FLOAT
See Also:
Constant Field Values

CL_FLOAT

static final int CL_FLOAT
See Also:
Constant Field Values

CL_IMAGE_FORMAT

static final int CL_IMAGE_FORMAT
See Also:
Constant Field Values

CL_IMAGE_ELEMENT_SIZE

static final int CL_IMAGE_ELEMENT_SIZE
See Also:
Constant Field Values

CL_IMAGE_ROW_PITCH

static final int CL_IMAGE_ROW_PITCH
See Also:
Constant Field Values

CL_IMAGE_SLICE_PITCH

static final int CL_IMAGE_SLICE_PITCH
See Also:
Constant Field Values

CL_IMAGE_WIDTH

static final int CL_IMAGE_WIDTH
See Also:
Constant Field Values

CL_IMAGE_HEIGHT

static final int CL_IMAGE_HEIGHT
See Also:
Constant Field Values

CL_IMAGE_DEPTH

static final int CL_IMAGE_DEPTH
See Also:
Constant Field Values
Method Detail

clCreateImage2D

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 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);


clCreateImage2D

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 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);


clCreateImage3D

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 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);


clCreateImage3D

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 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);


clGetImageInfo

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 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 - a direct Buffer
param_value_size_ret - a direct PointerBuffer