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

```
public class INTELCreateBufferWithProperties
extends java.lang.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 Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static long`	`clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, double[] host_ptr, int[] errcode_ret)`	Array version of: `CreateBufferWithPropertiesINTEL`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, float[] host_ptr, int[] errcode_ret)`	Array version of: `CreateBufferWithPropertiesINTEL`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, int[] host_ptr, int[] errcode_ret)`	Array version of: `CreateBufferWithPropertiesINTEL`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, short[] host_ptr, int[] errcode_ret)`	Array version of: `CreateBufferWithPropertiesINTEL`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, java.nio.ByteBuffer host_ptr, int[] errcode_ret)`	Array version of: `CreateBufferWithPropertiesINTEL`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, long size, java.nio.IntBuffer errcode_ret)`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, java.nio.ByteBuffer host_ptr, java.nio.IntBuffer errcode_ret)`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, java.nio.DoubleBuffer host_ptr, java.nio.IntBuffer errcode_ret)`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, java.nio.FloatBuffer host_ptr, java.nio.IntBuffer errcode_ret)`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, java.nio.IntBuffer host_ptr, java.nio.IntBuffer errcode_ret)`
`static long`	`clCreateBufferWithPropertiesINTEL(long context, java.nio.LongBuffer properties, long flags, java.nio.ShortBuffer host_ptr, java.nio.IntBuffer errcode_ret)`
`static long`	`nclCreateBufferWithPropertiesINTEL(long context, long properties, long flags, long size, long host_ptr, long errcode_ret)`	Unsafe version of: `CreateBufferWithPropertiesINTEL`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

nclCreateBufferWithPropertiesINTEL

public static long nclCreateBufferWithPropertiesINTEL(long context,
                                                      long properties,
                                                      long flags,
                                                      long size,
                                                      long host_ptr,
                                                      long errcode_ret)

Unsafe version of: CreateBufferWithPropertiesINTEL

Parameters:: size - the size in bytes of the buffer memory object to be allocated

clCreateBufferWithPropertiesINTEL
```
public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     long size,
                                                     @Nullable
                                                     java.nio.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:
- INVALID_CONTEXT if context is not a valid context.
- INVALID_VALUE if a property name in properties is not a supported property name, if the value specified for a supported property name is not valid, or if the same property name is specified more than once.
- INVALID_VALUE if values specified in flags are not valid as defined in table 5.3.
- INVALID_BUFFER_SIZE if size is 0.
- INVALID_HOST_PTR if host_ptr is NULL and MEM_USE_HOST_PTR or MEM_COPY_HOST_PTR are set in flags or if host_ptr is not NULL but MEM_COPY_HOST_PTR or MEM_USE_HOST_PTR are not set in flags.
- MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to allocate memory for buffer object.
- OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
- OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

clCreateBufferWithPropertiesINTEL

public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     java.nio.ByteBuffer host_ptr,
                                                     @Nullable
                                                     java.nio.IntBuffer errcode_ret)

public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     java.nio.ShortBuffer host_ptr,
                                                     @Nullable
                                                     java.nio.IntBuffer errcode_ret)

public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     java.nio.IntBuffer host_ptr,
                                                     @Nullable
                                                     java.nio.IntBuffer errcode_ret)

public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     java.nio.FloatBuffer host_ptr,
                                                     @Nullable
                                                     java.nio.IntBuffer errcode_ret)

public static long clCreateBufferWithPropertiesINTEL(long context,
                                                     @Nullable
                                                     java.nio.LongBuffer properties,
                                                     long flags,
                                                     java.nio.DoubleBuffer host_ptr,
                                                     @Nullable
                                                     java.nio.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:

INVALID_CONTEXT if context is not a valid context.
INVALID_VALUE if a property name in properties is not a supported property name, if the value specified for a supported property name is not valid, or if the same property name is specified more than once.
INVALID_VALUE if values specified in flags are not valid as defined in table 5.3.
INVALID_BUFFER_SIZE if size is 0.
INVALID_HOST_PTR if host_ptr is NULL and MEM_USE_HOST_PTR or MEM_COPY_HOST_PTR are set in flags or if host_ptr is not NULL but MEM_COPY_HOST_PTR or MEM_USE_HOST_PTR are not set in flags.
MEM_OBJECT_ALLOCATION_FAILURE if there is a failure to allocate memory for buffer object.
OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.
OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

clCreateBufferWithPropertiesINTEL

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

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

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

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

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

Array version of: CreateBufferWithPropertiesINTEL

Class INTELCreateBufferWithProperties

Method Summary

Methods inherited from class java.lang.Object

Method Detail

nclCreateBufferWithPropertiesINTEL

clCreateBufferWithPropertiesINTEL

clCreateBufferWithPropertiesINTEL

clCreateBufferWithPropertiesINTEL