CLMemEXTHostPtr (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.opencl.CLMemEXTHostPtr

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CLMemEXTHostPtr
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Accepted by the host_ptr argument of CreateBuffer, CreateImage2D and CreateImage3D.
Member documentation
- allocation_type – type of external memory allocation. Legal values will be defined in layered extensions.
- host_cache_policy – host cache policy for this external memory allocation
Layout
```
 struct cl_mem_ext_host_ptr {
     cl_uint allocation_type;
     cl_uint host_cache_policy;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CLMemEXTHostPtr.Buffer
An array of CLMemEXTHostPtr structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOCATION_TYPE` The struct member offsets.
`static int`	`HOST_CACHE_POLICY` The struct member offsets.
`static 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 and Description

CLMemEXTHostPtr(java.nio.ByteBuffer container)
Creates a CLMemEXTHostPtr instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`CLMemEXTHostPtr(java.nio.ByteBuffer container)` Creates a `CLMemEXTHostPtr` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`allocation_type()` Returns the value of the `allocation_type` field.
`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`	`callocStack()` Returns a new `CLMemEXTHostPtr` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLMemEXTHostPtr.Buffer`	`callocStack(int capacity)` Returns a new `CLMemEXTHostPtr.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLMemEXTHostPtr.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLMemEXTHostPtr.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLMemEXTHostPtr`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLMemEXTHostPtr` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 CLMemEXTHostPtr`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CLMemEXTHostPtr.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`host_cache_policy()` Returns the value of the `host_cache_policy` field.
`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`	`mallocStack()` Returns a new `CLMemEXTHostPtr` instance allocated on the thread-local `MemoryStack`.
`static CLMemEXTHostPtr.Buffer`	`mallocStack(int capacity)` Returns a new `CLMemEXTHostPtr.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CLMemEXTHostPtr.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLMemEXTHostPtr.Buffer` instance allocated on the specified `MemoryStack`.
`static CLMemEXTHostPtr`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLMemEXTHostPtr` instance allocated on the specified `MemoryStack`.
`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(CLMemEXTHostPtr src)` Copies the specified struct data to this struct.
`CLMemEXTHostPtr`	`set(int allocation_type, int host_cache_policy)` Initializes this struct with the specified values.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - CLMemEXTHostPtr
```
public CLMemEXTHostPtr(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - 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
```
@Nullable
public static 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
```
@Nullable
public static CLMemEXTHostPtr.Buffer createSafe(long address,
                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CLMemEXTHostPtr mallocStack()
```
    Returns a new CLMemEXTHostPtr instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CLMemEXTHostPtr callocStack()
```
    Returns a new CLMemEXTHostPtr instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CLMemEXTHostPtr mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLMemEXTHostPtr instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CLMemEXTHostPtr callocStack(org.lwjgl.system.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
  - mallocStack
```
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity)
```
    Returns a new CLMemEXTHostPtr.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CLMemEXTHostPtr.Buffer callocStack(int capacity)
```
    Returns a new CLMemEXTHostPtr.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CLMemEXTHostPtr.Buffer mallocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CLMemEXTHostPtr.Buffer callocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLMemEXTHostPtr.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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.

Class CLMemEXTHostPtr

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ALLOCATION_TYPE

HOST_CACHE_POLICY

Constructor Detail

CLMemEXTHostPtr

Method Detail

sizeof

allocation_type

host_cache_policy

allocation_type

host_cache_policy

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nallocation_type

nhost_cache_policy

nallocation_type

nhost_cache_policy