org.lwjgl.opencl.QCOMEXTHostPtr Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-opencl Show documentation
Show all versions of lwjgl-opencl Show documentation
An open, royalty-free standard for cross-platform, parallel programming of diverse processors found in personal computers, servers, mobile devices and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.opencl;
import java.nio.*;
import org.lwjgl.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* Native bindings to the qcom_ext_host_ptr extension.
*
* This extension extends the functionality provided by {@link CL10#clCreateBuffer CreateBuffer}, {@link CL10#clCreateImage2D CreateImage2D}, {@link CL10#clCreateImage3D CreateImage3D}. It allows applications to specify
* a new flag {@link #CL_MEM_EXT_HOST_PTR_QCOM 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 {@link CL11 CL11}.
*/
public class QCOMEXTHostPtr {
/** Accepted by the {@code param_name} argument of {@link CL10#clGetDeviceInfo GetDeviceInfo}. */
public static final int
CL_DEVICE_EXT_MEM_PADDING_IN_BYTES_QCOM = 0x40A0,
CL_DEVICE_PAGE_SIZE_QCOM = 0x40A1;
/** Accepted by the {@code flags} argument of {@link CL10#clCreateBuffer CreateBuffer}, {@link CL10#clCreateImage2D CreateImage2D} and {@link CL10#clCreateImage3D CreateImage3D}. */
public static final int CL_MEM_EXT_HOST_PTR_QCOM = 1 << 29;
/** host_cache_policy. */
public static final int
CL_MEM_HOST_UNCACHED_QCOM = 0x40A4,
CL_MEM_HOST_WRITEBACK_QCOM = 0x40A5,
CL_MEM_HOST_WRITETHROUGH_QCOM = 0x40A6,
CL_MEM_HOST_WRITE_COMBINING_QCOM = 0x40A7;
/** Accepted by the {@code param_name} argument of {@link #clGetDeviceImageInfoQCOM GetDeviceImageInfoQCOM}. */
public static final int
CL_IMAGE_ROW_ALIGNMENT_QCOM = 0x40A2,
CL_IMAGE_SLICE_ALIGNMENT_QCOM = 0x40A3;
protected QCOMEXTHostPtr() {
throw new UnsupportedOperationException();
}
static boolean isAvailable(CLCapabilities caps) {
return checkFunctions(
caps.clGetDeviceImageInfoQCOM
);
}
// --- [ clGetDeviceImageInfoQCOM ] ---
/**
* Unsafe version of: {@link #clGetDeviceImageInfoQCOM GetDeviceImageInfoQCOM}
*
* @param param_value_size the size in bytes of memory pointed to by {@code param_value}. This size must be ≥ size of return type. If {@code param_value} is {@code NULL}, it is ignored.
*/
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) {
long __functionAddress = CL.getICD().clGetDeviceImageInfoQCOM;
if ( CHECKS ) {
checkFunctionAddress(__functionAddress);
checkPointer(device);
}
return callPPPPPPPI(__functionAddress, device, image_width, image_height, image_format, param_name, param_value_size, param_value, param_value_size_ret);
}
/**
* An application that creates OpenCL image objects with the {@link #CL_MEM_EXT_HOST_PTR_QCOM MEM_EXT_HOST_PTR_QCOM} flag can invoke this function to query the required row pitch, slice
* pitch and alignment for a particular device.
*
* @param device a valid device
* @param image_width width of the image in image elements (pixels)
* @param image_height height of the image in image elements (pixels)
* @param image_format format of the image
* @param param_name the parameter to query. One of:
{@link CL10#CL_IMAGE_ROW_PITCH IMAGE_ROW_PITCH} {@link CL10#CL_IMAGE_SLICE_PITCH IMAGE_SLICE_PITCH} {@link #CL_IMAGE_ROW_ALIGNMENT_QCOM IMAGE_ROW_ALIGNMENT_QCOM} {@link #CL_IMAGE_SLICE_ALIGNMENT_QCOM IMAGE_SLICE_ALIGNMENT_QCOM}
* @param param_value a pointer to memory where the appropriate result being queried is returned. If {@code param_value} is {@code NULL}, it is ignored.
* @param param_value_size_ret the actual size in bytes of data being queried by {@code param_value}. If {@code NULL}, it is ignored.
*/
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) {
if ( CHECKS )
checkBufferSafe(param_value_size_ret, 1);
return nclGetDeviceImageInfoQCOM(device, image_width, image_height, image_format.address(), param_name, remainingSafe(param_value), memAddressSafe(param_value), memAddressSafe(param_value_size_ret));
}
/**
* An application that creates OpenCL image objects with the {@link #CL_MEM_EXT_HOST_PTR_QCOM MEM_EXT_HOST_PTR_QCOM} flag can invoke this function to query the required row pitch, slice
* pitch and alignment for a particular device.
*
* @param device a valid device
* @param image_width width of the image in image elements (pixels)
* @param image_height height of the image in image elements (pixels)
* @param image_format format of the image
* @param param_name the parameter to query. One of:
{@link CL10#CL_IMAGE_ROW_PITCH IMAGE_ROW_PITCH} {@link CL10#CL_IMAGE_SLICE_PITCH IMAGE_SLICE_PITCH} {@link #CL_IMAGE_ROW_ALIGNMENT_QCOM IMAGE_ROW_ALIGNMENT_QCOM} {@link #CL_IMAGE_SLICE_ALIGNMENT_QCOM IMAGE_SLICE_ALIGNMENT_QCOM}
* @param param_value a pointer to memory where the appropriate result being queried is returned. If {@code param_value} is {@code NULL}, it is ignored.
* @param param_value_size_ret the actual size in bytes of data being queried by {@code param_value}. If {@code NULL}, it is ignored.
*/
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) {
if ( CHECKS )
checkBufferSafe(param_value_size_ret, 1);
return nclGetDeviceImageInfoQCOM(device, image_width, image_height, image_format.address(), param_name, remainingSafe(param_value) << 2, memAddressSafe(param_value), memAddressSafe(param_value_size_ret));
}
/** Array version of: {@link #clGetDeviceImageInfoQCOM GetDeviceImageInfoQCOM} */
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) {
long __functionAddress = CL.getICD().clGetDeviceImageInfoQCOM;
if ( CHECKS ) {
checkFunctionAddress(__functionAddress);
checkPointer(device);
checkBufferSafe(param_value_size_ret, 1);
}
return callPPPPPPPI(__functionAddress, device, image_width, image_height, image_format.address(), param_name, (long)(lengthSafe(param_value) << 2), param_value, memAddressSafe(param_value_size_ret));
}
}