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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class CLBufferRegion
extends Struct
```
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
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  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.

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, MemoryStack stack)` Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CLBufferRegion`	`callocStack(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 or `null` if the address is `NULL`.
`static CLBufferRegion.Buffer`	`create(long address, int capacity)` Create a `CLBufferRegion.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack`.
`static CLBufferRegion`	`mallocStack(MemoryStack stack)` Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack`.
`CLBufferRegion`	`nset(long struct)` Unsafe version of `set`.
`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()` Returns the `sizeof(struct)`.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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.
  - nset
```
public CLBufferRegion nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                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,
                                                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

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

Constructor Detail

CLBufferRegion

Method Detail

sizeof

origin

size

origin

size

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack