Top Description Constructors Methods
org.lwjgl.opencl

public Class INTELCreateBufferWithProperties

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

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.

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
long
the size in bytes of the buffer memory object to be allocated
size
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
ByteBuffer
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.
host_ptr
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
ShortBuffer
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.
host_ptr
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
IntBuffer
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.
host_ptr
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
FloatBuffer
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.
host_ptr
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

public static long

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
(long
a valid OpenCL context used to create the buffer object
context
,
LongBuffer
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.

properties
,
long
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
flags
,
DoubleBuffer
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.
host_ptr
,
IntBuffer
will return an appropriate error code. If errcode_ret is NULL, no error code is returned.
errcode_ret
)

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

Array version of: CreateBufferWithPropertiesINTEL

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

Array version of: CreateBufferWithPropertiesINTEL

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

Array version of: CreateBufferWithPropertiesINTEL

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

Array version of: CreateBufferWithPropertiesINTEL

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

Array version of: CreateBufferWithPropertiesINTEL

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

Unsafe version of: CreateBufferWithPropertiesINTEL

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

INTELCreateBufferWithPropertiesback to summary
protected INTELCreateBufferWithProperties()

Method Detail

clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, long size, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:long

the size in bytes of the buffer memory object to be allocated

errcode_ret:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, ByteBuffer host_ptr, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:ByteBuffer

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:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, ShortBuffer host_ptr, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:ShortBuffer

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:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, IntBuffer host_ptr, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:IntBuffer

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:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, FloatBuffer host_ptr, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:FloatBuffer

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:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, LongBuffer properties, long flags, DoubleBuffer host_ptr, IntBuffer errcode_ret)
Parameters
context:long

a valid OpenCL context used to create the buffer object

properties:LongBuffer

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:long

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:DoubleBuffer

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:IntBuffer

will return an appropriate error code. If errcode_ret is NULL, no error code is returned.

Returns:long

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:

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, ByteBuffer host_ptr, int[] errcode_ret)

Array version of: CreateBufferWithPropertiesINTEL

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, short[] host_ptr, int[] errcode_ret)

Array version of: CreateBufferWithPropertiesINTEL

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, int[] host_ptr, int[] errcode_ret)

Array version of: CreateBufferWithPropertiesINTEL

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, float[] host_ptr, int[] errcode_ret)

Array version of: CreateBufferWithPropertiesINTEL

Annotations
@NativeType:cl_mem
clCreateBufferWithPropertiesINTELback to summary
public static long clCreateBufferWithPropertiesINTEL(long context, long[] properties, long flags, double[] host_ptr, int[] errcode_ret)

Array version of: CreateBufferWithPropertiesINTEL

Annotations
@NativeType:cl_mem
nclCreateBufferWithPropertiesINTELback to summary
public static long nclCreateBufferWithPropertiesINTEL(long context, long properties, long flags, long size, long host_ptr, long errcode_ret)

Unsafe version of: CreateBufferWithPropertiesINTEL

Parameters
size:long

the size in bytes of the buffer memory object to be allocated