Package org.lwjgl.opencl

Class CLMemEXTHostPtr

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CLMemEXTHostPtr>

org.lwjgl.opencl.CLMemEXTHostPtr

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class CLMemEXTHostPtr
extends Struct<CLMemEXTHostPtr>
implements NativeResource

 struct cl_mem_ext_host_ptr {
     cl_uint allocation_type;
     cl_uint host_cache_policy;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CLMemEXTHostPtr.Buffer	An array of CLMemEXTHostPtr structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ALLOCATION_TYPE	The struct member offsets.
static final int	HOST_CACHE_POLICY	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
CLMemEXTHostPtr(ByteBuffer container)	Creates a CLMemEXTHostPtr instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	allocation_type()
CLMemEXTHostPtr	allocation_type(int value)	Sets the specified value to the allocation_type field.
static CLMemEXTHostPtr	calloc()	Returns a new CLMemEXTHostPtr instance allocated with memCalloc.
static CLMemEXTHostPtr.Buffer	calloc(int capacity)	Returns a new CLMemEXTHostPtr.Buffer instance allocated with memCalloc.
static CLMemEXTHostPtr.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CLMemEXTHostPtr	calloc(MemoryStack stack)	Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CLMemEXTHostPtr	callocStack()	Deprecated.
static CLMemEXTHostPtr.Buffer	callocStack(int capacity)	Deprecated.
static CLMemEXTHostPtr.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static CLMemEXTHostPtr	callocStack(MemoryStack stack)	Deprecated.
static CLMemEXTHostPtr	create()	Returns a new CLMemEXTHostPtr instance allocated with BufferUtils.
static CLMemEXTHostPtr.Buffer	create(int capacity)	Returns a new CLMemEXTHostPtr.Buffer instance allocated with BufferUtils.
static CLMemEXTHostPtr	create(long address)	Returns a new CLMemEXTHostPtr instance for the specified memory address.
static CLMemEXTHostPtr.Buffer	create(long address, int capacity)	Create a CLMemEXTHostPtr.Buffer instance at the specified memory.
static @Nullable CLMemEXTHostPtr	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable CLMemEXTHostPtr.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	host_cache_policy()
CLMemEXTHostPtr	host_cache_policy(int value)	Sets the specified value to the host_cache_policy field.
static CLMemEXTHostPtr	malloc()	Returns a new CLMemEXTHostPtr instance allocated with memAlloc.
static CLMemEXTHostPtr.Buffer	malloc(int capacity)	Returns a new CLMemEXTHostPtr.Buffer instance allocated with memAlloc.
static CLMemEXTHostPtr.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack.
static CLMemEXTHostPtr	malloc(MemoryStack stack)	Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack.
static CLMemEXTHostPtr	mallocStack()	Deprecated.
static CLMemEXTHostPtr.Buffer	mallocStack(int capacity)	Deprecated.
static CLMemEXTHostPtr.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static CLMemEXTHostPtr	mallocStack(MemoryStack stack)	Deprecated.
static int	nallocation_type(long struct)	Unsafe version of allocation_type().
static void	nallocation_type(long struct, int value)	Unsafe version of allocation_type.
static int	nhost_cache_policy(long struct)	Unsafe version of host_cache_policy().
static void	nhost_cache_policy(long struct, int value)	Unsafe version of host_cache_policy.
CLMemEXTHostPtr	set(int allocation_type, int host_cache_policy)	Initializes this struct with the specified values.
CLMemEXTHostPtr	set(CLMemEXTHostPtr src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

ALLOCATION_TYPE

public static final int ALLOCATION_TYPE

The struct member offsets.

HOST_CACHE_POLICY

public static final int HOST_CACHE_POLICY

The struct member offsets.

Constructor Details

CLMemEXTHostPtr

public CLMemEXTHostPtr(ByteBuffer container)

Creates a CLMemEXTHostPtr instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<CLMemEXTHostPtr>

allocation_type

public int allocation_type()

Returns:

the value of the allocation_type field.

host_cache_policy

public int host_cache_policy()

Returns:

the value of the host_cache_policy field.

allocation_type

public CLMemEXTHostPtr allocation_type(int value)

Sets the specified value to the allocation_type field.

host_cache_policy

public CLMemEXTHostPtr host_cache_policy(int value)

Sets the specified value to the host_cache_policy field.

set

public CLMemEXTHostPtr set(int allocation_type,
 int host_cache_policy)

Initializes this struct with the specified values.

set

public CLMemEXTHostPtr set(CLMemEXTHostPtr src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static CLMemEXTHostPtr malloc()

Returns a new CLMemEXTHostPtr instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static CLMemEXTHostPtr calloc()

Returns a new CLMemEXTHostPtr instance allocated with memCalloc. The instance must be explicitly freed.

create

public static CLMemEXTHostPtr create()

Returns a new CLMemEXTHostPtr instance allocated with BufferUtils.

create

public static CLMemEXTHostPtr create(long address)

Returns a new CLMemEXTHostPtr instance for the specified memory address.

createSafe

public static @Nullable CLMemEXTHostPtr createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static CLMemEXTHostPtr.Buffer malloc(int capacity)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static CLMemEXTHostPtr.Buffer calloc(int capacity)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static CLMemEXTHostPtr.Buffer create(int capacity)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static CLMemEXTHostPtr.Buffer create(long address,
 int capacity)

Create a CLMemEXTHostPtr.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable CLMemEXTHostPtr.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static CLMemEXTHostPtr mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static CLMemEXTHostPtr callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static CLMemEXTHostPtr mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static CLMemEXTHostPtr callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static CLMemEXTHostPtr.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static CLMemEXTHostPtr.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static CLMemEXTHostPtr malloc(MemoryStack stack)

Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static CLMemEXTHostPtr calloc(MemoryStack stack)

Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static CLMemEXTHostPtr.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static CLMemEXTHostPtr.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nallocation_type

public static int nallocation_type(long struct)

Unsafe version of allocation_type().

nhost_cache_policy

public static int nhost_cache_policy(long struct)

Unsafe version of host_cache_policy().

nallocation_type

public static void nallocation_type(long struct,
 int value)

Unsafe version of allocation_type.

nhost_cache_policy

public static void nhost_cache_policy(long struct,
 int value)

Unsafe version of host_cache_policy.