org.lwjgl.opencl

Class QCOMEXTHostPtr

java.lang.Object

org.lwjgl.opencl.QCOMEXTHostPtr

public class QCOMEXTHostPtr
extends java.lang.Object

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

Fields

Modifier and Type	Field and Description
static int	CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM Accepted by the param_name argument of GetDeviceInfo.
static int	CL_DEVICE_PAGE_SIZE_QCOM Accepted by the param_name argument of GetDeviceInfo.
static int	CL_IMAGE_ROW_ALIGNMENT_QCOM Accepted by the param_name argument of GetDeviceImageInfoQCOM.
static int	CL_IMAGE_SLICE_ALIGNMENT_QCOM Accepted by the param_name argument of GetDeviceImageInfoQCOM.
static int	CL_MEM_EXT_HOST_PTR_QCOM Accepted by the flags argument of CreateBuffer, CreateImage2D and CreateImage3D.
static int	CL_MEM_HOST_UNCACHED_QCOM host_cache_policy.
static int	CL_MEM_HOST_WRITE_COMBINING_QCOM host_cache_policy.
static int	CL_MEM_HOST_WRITEBACK_QCOM host_cache_policy.
static int	CL_MEM_HOST_WRITETHROUGH_QCOM host_cache_policy.

Method Summary

Modifier and Type	Method and Description
static int	clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, java.nio.ByteBuffer param_value, org.lwjgl.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.
static int	clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, int[] param_value, org.lwjgl.PointerBuffer param_value_size_ret) Array version of: GetDeviceImageInfoQCOM
static int	clGetDeviceImageInfoQCOM(long device, long image_width, long image_height, CLImageFormat image_format, int param_name, java.nio.IntBuffer param_value, org.lwjgl.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.
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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM

public static final int CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM

Accepted by the param_name argument of GetDeviceInfo.

See Also:

Constant Field Values

CL_DEVICE_PAGE_SIZE_QCOM

public static final int CL_DEVICE_PAGE_SIZE_QCOM

Accepted by the param_name argument of GetDeviceInfo.

See Also:

Constant Field Values

CL_MEM_EXT_HOST_PTR_QCOM

public static final int CL_MEM_EXT_HOST_PTR_QCOM

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

See Also:

Constant Field Values

CL_MEM_HOST_UNCACHED_QCOM

public static final int CL_MEM_HOST_UNCACHED_QCOM

host_cache_policy.

See Also:

Constant Field Values

CL_MEM_HOST_WRITEBACK_QCOM

public static final int CL_MEM_HOST_WRITEBACK_QCOM

host_cache_policy.

See Also:

Constant Field Values

CL_MEM_HOST_WRITETHROUGH_QCOM

public static final int CL_MEM_HOST_WRITETHROUGH_QCOM

host_cache_policy.

See Also:

Constant Field Values

CL_MEM_HOST_WRITE_COMBINING_QCOM

public static final int CL_MEM_HOST_WRITE_COMBINING_QCOM

host_cache_policy.

See Also:

Constant Field Values

CL_IMAGE_ROW_ALIGNMENT_QCOM

public static final int CL_IMAGE_ROW_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

See Also:

Constant Field Values

CL_IMAGE_SLICE_ALIGNMENT_QCOM

public static final int CL_IMAGE_SLICE_ALIGNMENT_QCOM

Accepted by the param_name argument of GetDeviceImageInfoQCOM.

See Also:

Constant Field Values

Method Detail

nclGetDeviceImageInfoQCOM

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 - 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.

clGetDeviceImageInfoQCOM

public static int clGetDeviceImageInfoQCOM(long device,
                                           long image_width,
                                           long image_height,
                                           CLImageFormat image_format,
                                           int param_name,
                                           @Nullable
                                           java.nio.ByteBuffer param_value,
                                           @Nullable
                                           org.lwjgl.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 - a valid device

image_width - width of the image in image elements (pixels)

image_height - height of the image in image elements (pixels)

image_format - format of the image

param_name - the parameter to query. One of:

IMAGE_ROW_PITCH	IMAGE_SLICE_PITCH	IMAGE_ROW_ALIGNMENT_QCOM
IMAGE_SLICE_ALIGNMENT_QCOM

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

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

clGetDeviceImageInfoQCOM

public static int clGetDeviceImageInfoQCOM(long device,
                                           long image_width,
                                           long image_height,
                                           CLImageFormat image_format,
                                           int param_name,
                                           @Nullable
                                           java.nio.IntBuffer param_value,
                                           @Nullable
                                           org.lwjgl.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 - a valid device

image_width - width of the image in image elements (pixels)

image_height - height of the image in image elements (pixels)

image_format - format of the image

param_name - the parameter to query. One of:

IMAGE_ROW_PITCH	IMAGE_SLICE_PITCH	IMAGE_ROW_ALIGNMENT_QCOM
IMAGE_SLICE_ALIGNMENT_QCOM

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

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

clGetDeviceImageInfoQCOM

public static int clGetDeviceImageInfoQCOM(long device,
                                           long image_width,
                                           long image_height,
                                           CLImageFormat image_format,
                                           int param_name,
                                           @Nullable
                                           int[] param_value,
                                           @Nullable
                                           org.lwjgl.PointerBuffer param_value_size_ret)

Array version of: GetDeviceImageInfoQCOM