Top Description Fields Constructors Methods
org.lwjgl.opencl

public Class QCOMEXTHostPtr

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Native bindings to the qcom_ext_host_ptr extension.

This extension extends the functionality provided by CreateBuffer, CreateImage2D, CreateImage3D. It allows applications to specify a new flag MEM_EXT_HOST_PTR_QCOM which enables the driver to map external memory allocations --to be defined in future layered extensions-- to the device's address space and thus avoiding having to copy data back and forth between the host and the device.

Requires CL11.

Field Summary

Modifier and TypeField and Description
public static final int
CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM

Accepted by the param_name argument of GetDeviceInfo.

public static final int
CL_DEVICE_PAGE_SIZE_QCOM

Accepted by the param_name argument of GetDeviceInfo.

public static final int
CL_IMAGE_ROW_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

public static final int
CL_IMAGE_SLICE_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

public static final int
CL_MEM_EXT_HOST_PTR_QCOM

Accepted by the flags argument of CreateBuffer, CreateImage2D and CreateImage3D.

public static final int
CL_MEM_HOST_UNCACHED_QCOM

host_cache_policy.

public static final int
public static final int
CL_MEM_HOST_WRITEBACK_QCOM

host_cache_policy.

public static final int

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static int
clGetDeviceImageInfoQCOM(long
a valid device
device
,
long
width of the image in image elements (pixels)
image_width
,
long
height of the image in image elements (pixels)
image_height
,
CLImageFormat
format of the image
image_format
,
int param_name, ByteBuffer
a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.
param_value
,
PointerBuffer
the actual size in bytes of data being queried by param_value. If NULL, it is ignored.
param_value_size_ret
)

An application that creates OpenCL image objects with the MEM_EXT_HOST_PTR_QCOM flag can invoke this function to query the required row pitch, slice pitch and alignment for a particular device.

public static int
clGetDeviceImageInfoQCOM(long
a valid device
device
,
long
width of the image in image elements (pixels)
image_width
,
long
height of the image in image elements (pixels)
image_height
,
CLImageFormat
format of the image
image_format
,
int param_name, IntBuffer
a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.
param_value
,
PointerBuffer
the actual size in bytes of data being queried by param_value. If NULL, it is ignored.
param_value_size_ret
)

An application that creates OpenCL image objects with the MEM_EXT_HOST_PTR_QCOM flag can invoke this function to query the required row pitch, slice pitch and alignment for a particular device.

public static int
clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, int[] param_value, PointerBuffer param_value_size_ret)

Array version of: GetDeviceImageInfoQCOM

public static int
nclGetDeviceImageInfoQCOM(long device, long image_width, long image_height, long image_format, int param_name, long
the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type. If param_value is NULL, it is ignored.
param_value_size
,
long param_value, long param_value_size_ret)

Unsafe version of: GetDeviceImageInfoQCOM

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOMback to summary
public static final int CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM

Accepted by the param_name argument of GetDeviceInfo.

CL_DEVICE_PAGE_SIZE_QCOMback to summary
public static final int CL_DEVICE_PAGE_SIZE_QCOM

Accepted by the param_name argument of GetDeviceInfo.

CL_IMAGE_ROW_ALIGNMENT_QCOMback to summary
public static final int CL_IMAGE_ROW_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

CL_IMAGE_SLICE_ALIGNMENT_QCOMback to summary
public static final int CL_IMAGE_SLICE_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

CL_MEM_EXT_HOST_PTR_QCOMback to summary
public static final int CL_MEM_EXT_HOST_PTR_QCOM

Accepted by the flags argument of CreateBuffer, CreateImage2D and CreateImage3D.

CL_MEM_HOST_UNCACHED_QCOMback to summary
public static final int CL_MEM_HOST_UNCACHED_QCOM

host_cache_policy.

CL_MEM_HOST_WRITE_COMBINING_QCOMback to summary
public static final int CL_MEM_HOST_WRITE_COMBINING_QCOM

host_cache_policy.

CL_MEM_HOST_WRITEBACK_QCOMback to summary
public static final int CL_MEM_HOST_WRITEBACK_QCOM

host_cache_policy.

CL_MEM_HOST_WRITETHROUGH_QCOMback to summary
public static final int CL_MEM_HOST_WRITETHROUGH_QCOM

host_cache_policy.

Constructor Detail

QCOMEXTHostPtrback to summary
protected QCOMEXTHostPtr()

Method Detail

clGetDeviceImageInfoQCOMback to summary
public static int clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, ByteBuffer param_value, PointerBuffer param_value_size_ret)

An application that creates OpenCL image objects with the MEM_EXT_HOST_PTR_QCOM flag can invoke this function to query the required row pitch, slice pitch and alignment for a particular device.

Parameters
device:long

a valid device

image_width:long

width of the image in image elements (pixels)

image_height:long

height of the image in image elements (pixels)

image_format:CLImageFormat

format of the image

param_name:int

the parameter to query. One of:

IMAGE_ROW_PITCHIMAGE_SLICE_PITCHIMAGE_ROW_ALIGNMENT_QCOM
IMAGE_SLICE_ALIGNMENT_QCOM
param_value:ByteBuffer

a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.

param_value_size_ret:PointerBuffer

the actual size in bytes of data being queried by param_value. If NULL, it is ignored.

Annotations
@NativeType:cl_int
clGetDeviceImageInfoQCOMback to summary
public static int clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, IntBuffer param_value, PointerBuffer param_value_size_ret)

An application that creates OpenCL image objects with the MEM_EXT_HOST_PTR_QCOM flag can invoke this function to query the required row pitch, slice pitch and alignment for a particular device.

Parameters
device:long

a valid device

image_width:long

width of the image in image elements (pixels)

image_height:long

height of the image in image elements (pixels)

image_format:CLImageFormat

format of the image

param_name:int

the parameter to query. One of:

IMAGE_ROW_PITCHIMAGE_SLICE_PITCHIMAGE_ROW_ALIGNMENT_QCOM
IMAGE_SLICE_ALIGNMENT_QCOM
param_value:IntBuffer

a pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.

param_value_size_ret:PointerBuffer

the actual size in bytes of data being queried by param_value. If NULL, it is ignored.

Annotations
@NativeType:cl_int
clGetDeviceImageInfoQCOMback to summary
public static int clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, int[] param_value, PointerBuffer param_value_size_ret)

Array version of: GetDeviceImageInfoQCOM

Annotations
@NativeType:cl_int
nclGetDeviceImageInfoQCOMback to summary
public static int nclGetDeviceImageInfoQCOM(long device, long image_width, long image_height, long image_format, int param_name, long param_value_size, long param_value, long param_value_size_ret)

Unsafe version of: GetDeviceImageInfoQCOM

Parameters
param_value_size:long

the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type. If param_value is NULL, it is ignored.