Top Description Inners Fields Constructors Methods
org.lwjgl.opencl

public Class CLMemEXTHostPtr

extends Struct<CLMemEXTHostPtr>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct cl_mem_ext_host_ptr
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Accepted by the host_ptr argument of CreateBuffer, CreateImage2D and CreateImage3D.

Layout


struct cl_mem_ext_host_ptr {
    cl_uint allocation_type;
    cl_uint host_cache_policy;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ALLOCATION_TYPE

The struct member offsets.

public static final int
HOST_CACHE_POLICY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CLMemEXTHostPtr(long address, ByteBuffer container)

public
CLMemEXTHostPtr(ByteBuffer container)

Creates a CLMemEXTHostPtr instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
allocation_type()

type of external memory allocation.

public CLMemEXTHostPtr
allocation_type(int value)

Sets the specified value to the allocation_type field.

public static CLMemEXTHostPtr
calloc()

Returns a new CLMemEXTHostPtr instance allocated with memCalloc.

public static CLMemEXTHostPtr.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with memCalloc.

public static CLMemEXTHostPtr
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static CLMemEXTHostPtr.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static CLMemEXTHostPtr
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected CLMemEXTHostPtr
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static CLMemEXTHostPtr
create()

Returns a new CLMemEXTHostPtr instance allocated with BufferUtils.

public static CLMemEXTHostPtr
create(long address)

Returns a new CLMemEXTHostPtr instance for the specified memory address.

public static CLMemEXTHostPtr.Buffer
create(int
the buffer capacity
capacity
)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with BufferUtils.

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

Create a CLMemEXTHostPtr.Buffer instance at the specified memory.

public static CLMemEXTHostPtr
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
host_cache_policy()

host cache policy for this external memory allocation

public CLMemEXTHostPtr
host_cache_policy(int value)

Sets the specified value to the host_cache_policy field.

public static CLMemEXTHostPtr
malloc()

Returns a new CLMemEXTHostPtr instance allocated with memAlloc.

public static CLMemEXTHostPtr.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with memAlloc.

public static CLMemEXTHostPtr
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack.

public static CLMemEXTHostPtr.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static CLMemEXTHostPtr
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CLMemEXTHostPtr.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nallocation_type(long struct)

Unsafe version of allocation_type.

public static void
nallocation_type(long struct, int value)

Unsafe version of allocation_type.

public static int
nhost_cache_policy(long struct)

Unsafe version of host_cache_policy.

public static void
nhost_cache_policy(long struct, int value)

Unsafe version of host_cache_policy.

public CLMemEXTHostPtr
set(int allocation_type, int host_cache_policy)

Initializes this struct with the specified values.

public CLMemEXTHostPtr

Returns:

this struct
set
(CLMemEXTHostPtr
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ALLOCATION_TYPEback to summary
public static final int ALLOCATION_TYPE

The struct member offsets.

HOST_CACHE_POLICYback to summary
public static final int HOST_CACHE_POLICY

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CLMemEXTHostPtrback to summary
protected CLMemEXTHostPtr(long address, ByteBuffer container)
CLMemEXTHostPtrback to summary
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 Detail

allocation_typeback to summary
public int allocation_type()

type of external memory allocation. Legal values will be defined in layered extensions.

Annotations
@NativeType:cl_uint
allocation_typeback to summary
public CLMemEXTHostPtr allocation_type(int value)

Sets the specified value to the allocation_type field.

callocback to summary
public static CLMemEXTHostPtr calloc()

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

callocback to summary
public static CLMemEXTHostPtr.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static CLMemEXTHostPtr callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CLMemEXTHostPtr callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CLMemEXTHostPtr.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static CLMemEXTHostPtr.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected CLMemEXTHostPtr create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static CLMemEXTHostPtr create()

Returns a new CLMemEXTHostPtr instance allocated with BufferUtils.

createback to summary
public static CLMemEXTHostPtr create(long address)

Returns a new CLMemEXTHostPtr instance for the specified memory address.

createback to summary
public static CLMemEXTHostPtr.Buffer create(int capacity)

Returns a new CLMemEXTHostPtr.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CLMemEXTHostPtr.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CLMemEXTHostPtr createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CLMemEXTHostPtr.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
host_cache_policyback to summary
public int host_cache_policy()

host cache policy for this external memory allocation

Annotations
@NativeType:cl_uint
host_cache_policyback to summary
public CLMemEXTHostPtr host_cache_policy(int value)

Sets the specified value to the host_cache_policy field.

mallocback to summary
public static CLMemEXTHostPtr malloc()

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

mallocback to summary
public static CLMemEXTHostPtr.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CLMemEXTHostPtr malloc(MemoryStack stack)

Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static CLMemEXTHostPtr mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CLMemEXTHostPtr mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nallocation_typeback to summary
public static int nallocation_type(long struct)

Unsafe version of allocation_type.

nallocation_typeback to summary
public static void nallocation_type(long struct, int value)

Unsafe version of allocation_type.

nhost_cache_policyback to summary
public static int nhost_cache_policy(long struct)

Unsafe version of host_cache_policy.

nhost_cache_policyback to summary
public static void nhost_cache_policy(long struct, int value)

Unsafe version of host_cache_policy.

setback to summary
public CLMemEXTHostPtr set(int allocation_type, int host_cache_policy)

Initializes this struct with the specified values.

setback to summary
public CLMemEXTHostPtr set(CLMemEXTHostPtr src)

Copies the specified struct data to this struct.

Parameters
src:CLMemEXTHostPtr

the source struct

Returns:CLMemEXTHostPtr

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.opencl back to summary

public Class CLMemEXTHostPtr.Buffer

extends StructBuffer<CLMemEXTHostPtr, CLMemEXTHostPtr.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CLMemEXTHostPtr structs.

Field Summary

Modifier and TypeField and Description
private static final CLMemEXTHostPtr

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CLMemEXTHostPtr.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the CLMemEXTHostPtr#allocation_type field.
allocation_type
()

public CLMemEXTHostPtr.Buffer
allocation_type(int value)

Sets the specified value to the CLMemEXTHostPtr#allocation_type field.

protected CLMemEXTHostPtr
public int

Returns:

the value of the CLMemEXTHostPtr#host_cache_policy field.
host_cache_policy
()

public CLMemEXTHostPtr.Buffer
host_cache_policy(int value)

Sets the specified value to the CLMemEXTHostPtr#host_cache_policy field.

protected CLMemEXTHostPtr.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CLMemEXTHostPtr ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CLMemEXTHostPtr.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by CLMemEXTHostPtr#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

allocation_typeback to summary
public int allocation_type()
Returns:int

the value of the CLMemEXTHostPtr#allocation_type field.

Annotations
@NativeType:cl_uint
allocation_typeback to summary
public CLMemEXTHostPtr.Buffer allocation_type(int value)

Sets the specified value to the CLMemEXTHostPtr#allocation_type field.

getElementFactoryback to summary
protected CLMemEXTHostPtr getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
host_cache_policyback to summary
public int host_cache_policy()
Returns:int

the value of the CLMemEXTHostPtr#host_cache_policy field.

Annotations
@NativeType:cl_uint
host_cache_policyback to summary
public CLMemEXTHostPtr.Buffer host_cache_policy(int value)

Sets the specified value to the CLMemEXTHostPtr#host_cache_policy field.

selfback to summary
protected CLMemEXTHostPtr.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override