Class INTELCreateBufferWithProperties

java.lang.Object
org.lwjgl.opencl.INTELCreateBufferWithProperties

public class INTELCreateBufferWithProperties extends Object
Native bindings to the intel_create_buffer_with_properties extension.

This extension allows OpenCL 1.x and 2.x devices to support the clCreateBufferWithProperties API that was added in OpenCL 3.0. This allows older OpenCL implementations to support other optional extensions or features that use the clCreateBufferWithProperties API to specify additional buffer properties, without recreating the API that is already part of OpenCL 3.0.

  • Method Details

    • nclCreateBufferWithPropertiesINTEL

      public static long nclCreateBufferWithPropertiesINTEL(long context, long properties, long flags, long size, long host_ptr, long errcode_ret)
      Parameters:
      size - the size in bytes of the buffer memory object to be allocated
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, long size, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      size - the size in bytes of the buffer memory object to be allocated
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, ByteBuffer host_ptr, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      host_ptr - a pointer to the buffer data that may already be allocated by the application. The size of the buffer that host_ptr points to must be greater than or equal to size bytes.
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, ShortBuffer host_ptr, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      host_ptr - a pointer to the buffer data that may already be allocated by the application. The size of the buffer that host_ptr points to must be greater than or equal to size bytes.
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, IntBuffer host_ptr, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      host_ptr - a pointer to the buffer data that may already be allocated by the application. The size of the buffer that host_ptr points to must be greater than or equal to size bytes.
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, FloatBuffer host_ptr, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      host_ptr - a pointer to the buffer data that may already be allocated by the application. The size of the buffer that host_ptr points to must be greater than or equal to size bytes.
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, @Nullable LongBuffer properties, long flags, DoubleBuffer host_ptr, @Nullable IntBuffer errcode_ret)
      Parameters:
      context - a valid OpenCL context used to create the buffer object
      properties - an optional list of properties for the buffer object and their corresponding values.

      Each property name is immediately followed by the corresponding desired value. The list is terminated with the special property 0. If no properties are required, properties may be NULL. This extension does not define any optional properties for buffers.

      flags - a bit-field that is used to specify allocation and usage information such as the memory arena that should be used to allocate the buffer object and how it will be used
      host_ptr - a pointer to the buffer data that may already be allocated by the application. The size of the buffer that host_ptr points to must be greater than or equal to size bytes.
      errcode_ret - will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
      Returns:
      a valid non-zero buffer object and errcode_ret is set to SUCCESS if the buffer object is created successfully. Otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, long @Nullable [] properties, long flags, ByteBuffer host_ptr, int @Nullable [] errcode_ret)
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, long @Nullable [] properties, long flags, short[] host_ptr, int @Nullable [] errcode_ret)
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, long @Nullable [] properties, long flags, int[] host_ptr, int @Nullable [] errcode_ret)
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, long @Nullable [] properties, long flags, float[] host_ptr, int @Nullable [] errcode_ret)
    • clCreateBufferWithPropertiesINTEL

      public static long clCreateBufferWithPropertiesINTEL(long context, long @Nullable [] properties, long flags, double[] host_ptr, int @Nullable [] errcode_ret)