CLBufferRegion (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CLBufferRegion
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Buffer region struct.
Member documentation
- origin – the region offset, in bytes
- size – the region size, in bytes
Layout
```
 struct cl_buffer_region {
     size_t origin;
     size_t size;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CLBufferRegion.Buffer
An array of CLBufferRegion 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`	`CLBufferRegion.Buffer` An array of `CLBufferRegion` structs.

Field Summary

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

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

Constructors
Constructor and Description
`CLBufferRegion(java.nio.ByteBuffer container)` Creates a `CLBufferRegion` 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
`static CLBufferRegion`	`calloc()` Returns a new `CLBufferRegion` instance allocated with `memCalloc`.
`static CLBufferRegion.Buffer`	`calloc(int capacity)` Returns a new `CLBufferRegion.Buffer` instance allocated with `memCalloc`.
`static CLBufferRegion`	`callocStack()` Returns a new `CLBufferRegion` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLBufferRegion.Buffer`	`callocStack(int capacity)` Returns a new `CLBufferRegion.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CLBufferRegion.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLBufferRegion`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLBufferRegion`	`create()` Returns a new `CLBufferRegion` instance allocated with `BufferUtils`.
`static CLBufferRegion.Buffer`	`create(int capacity)` Returns a new `CLBufferRegion.Buffer` instance allocated with `BufferUtils`.
`static CLBufferRegion`	`create(long address)` Returns a new `CLBufferRegion` instance for the specified memory address.
`static CLBufferRegion.Buffer`	`create(long address, int capacity)` Create a `CLBufferRegion.Buffer` instance at the specified memory.
`static CLBufferRegion`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CLBufferRegion.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static CLBufferRegion`	`malloc()` Returns a new `CLBufferRegion` instance allocated with `memAlloc`.
`static CLBufferRegion.Buffer`	`malloc(int capacity)` Returns a new `CLBufferRegion.Buffer` instance allocated with `memAlloc`.
`static CLBufferRegion`	`mallocStack()` Returns a new `CLBufferRegion` instance allocated on the thread-local `MemoryStack`.
`static CLBufferRegion.Buffer`	`mallocStack(int capacity)` Returns a new `CLBufferRegion.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CLBufferRegion.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack`.
`static CLBufferRegion`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack`.
`static long`	`norigin(long struct)` Unsafe version of `origin()`.
`static void`	`norigin(long struct, long value)` Unsafe version of `origin`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)` Unsafe version of `size`.
`long`	`origin()` Returns the value of the `origin` field.
`CLBufferRegion`	`origin(long value)` Sets the specified value to the `origin` field.
`CLBufferRegion`	`set(CLBufferRegion src)` Copies the specified struct data to this struct.
`CLBufferRegion`	`set(long origin, long size)` Initializes this struct with the specified values.
`long`	`size()` Returns the value of the `size` field.
`CLBufferRegion`	`size(long value)` Sets the specified value to the `size` field.
`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.
  - ORIGIN
```
public static final int ORIGIN
```
    The struct member offsets.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
- Constructor Detail
  - CLBufferRegion
```
public CLBufferRegion(java.nio.ByteBuffer container)
```
    Creates a CLBufferRegion 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
  - origin
```
public long origin()
```
    Returns the value of the origin field.
  - size
```
public long size()
```
    Returns the value of the size field.
  - origin
```
public CLBufferRegion origin(long value)
```
    Sets the specified value to the origin field.
  - size
```
public CLBufferRegion size(long value)
```
    Sets the specified value to the size field.
  - set
```
public CLBufferRegion set(long origin,
                          long size)
```
    Initializes this struct with the specified values.
  - set
```
public CLBufferRegion set(CLBufferRegion src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static CLBufferRegion malloc()
```
    Returns a new CLBufferRegion instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CLBufferRegion calloc()
```
    Returns a new CLBufferRegion instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CLBufferRegion create()
```
    Returns a new CLBufferRegion instance allocated with BufferUtils.
  - create
```
public static CLBufferRegion create(long address)
```
    Returns a new CLBufferRegion instance for the specified memory address.
  - createSafe
```
@Nullable
public static CLBufferRegion createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CLBufferRegion.Buffer malloc(int capacity)
```
    Returns a new CLBufferRegion.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CLBufferRegion.Buffer calloc(int capacity)
```
    Returns a new CLBufferRegion.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CLBufferRegion.Buffer create(int capacity)
```
    Returns a new CLBufferRegion.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CLBufferRegion.Buffer create(long address,
                                           int capacity)
```
    Create a CLBufferRegion.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CLBufferRegion.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CLBufferRegion mallocStack()
```
    Returns a new CLBufferRegion instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CLBufferRegion callocStack()
```
    Returns a new CLBufferRegion instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CLBufferRegion mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLBufferRegion instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CLBufferRegion callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLBufferRegion instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CLBufferRegion.Buffer mallocStack(int capacity)
```
    Returns a new CLBufferRegion.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CLBufferRegion.Buffer callocStack(int capacity)
```
    Returns a new CLBufferRegion.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CLBufferRegion.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLBufferRegion.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CLBufferRegion.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new CLBufferRegion.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
  - norigin
```
public static long norigin(long struct)
```
    Unsafe version of origin().
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - norigin
```
public static void norigin(long struct,
                           long value)
```
    Unsafe version of origin.
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Unsafe version of size.

Class CLBufferRegion

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

ORIGIN

SIZE

Constructor Detail

CLBufferRegion

Method Detail

sizeof

origin

size

origin

size

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

norigin

nsize

norigin

nsize