Package org.lwjgl.opencl
Class CLBufferRegion
- 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 bytessize
– 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 ofCLBufferRegion
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 aCLBufferRegion
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static CLBufferRegion
calloc()
Returns a newCLBufferRegion
instance allocated withmemCalloc
.static CLBufferRegion.Buffer
calloc(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withmemCalloc
.static CLBufferRegion
callocStack()
Returns a newCLBufferRegion
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static CLBufferRegion.Buffer
callocStack(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static CLBufferRegion.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newCLBufferRegion.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static CLBufferRegion
callocStack(MemoryStack stack)
Returns a newCLBufferRegion
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static CLBufferRegion
create()
Returns a newCLBufferRegion
instance allocated withBufferUtils
.static CLBufferRegion.Buffer
create(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withBufferUtils
.static CLBufferRegion
create(long address)
Returns a newCLBufferRegion
instance for the specified memory address ornull
if the address isNULL
.static CLBufferRegion.Buffer
create(long address, int capacity)
Create aCLBufferRegion.Buffer
instance at the specified memory.static CLBufferRegion
malloc()
Returns a newCLBufferRegion
instance allocated withmemAlloc
.static CLBufferRegion.Buffer
malloc(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withmemAlloc
.static CLBufferRegion
mallocStack()
Returns a newCLBufferRegion
instance allocated on the thread-localMemoryStack
.static CLBufferRegion.Buffer
mallocStack(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated on the thread-localMemoryStack
.static CLBufferRegion.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newCLBufferRegion.Buffer
instance allocated on the specifiedMemoryStack
.static CLBufferRegion
mallocStack(MemoryStack stack)
Returns a newCLBufferRegion
instance allocated on the specifiedMemoryStack
.CLBufferRegion
nset(long struct)
Unsafe version ofset
.long
origin()
Returns the value of theorigin
field.CLBufferRegion
origin(long value)
Sets the specified value to theorigin
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 thesize
field.CLBufferRegion
size(long value)
Sets the specified value to thesize
field.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
CLBufferRegion
public CLBufferRegion(java.nio.ByteBuffer container)
Creates aCLBufferRegion
instance at the current position of the specifiedByteBuffer
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 thesizeof(struct)
.
-
origin
public long origin()
Returns the value of theorigin
field.
-
size
public long size()
Returns the value of thesize
field.
-
origin
public CLBufferRegion origin(long value)
Sets the specified value to theorigin
field.
-
size
public CLBufferRegion size(long value)
Sets the specified value to thesize
field.
-
set
public CLBufferRegion set(long origin, long size)
Initializes this struct with the specified values.
-
nset
public CLBufferRegion nset(long struct)
Unsafe version ofset
.
-
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 newCLBufferRegion
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static CLBufferRegion calloc()
Returns a newCLBufferRegion
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static CLBufferRegion create()
Returns a newCLBufferRegion
instance allocated withBufferUtils
.
-
create
public static CLBufferRegion create(long address)
Returns a newCLBufferRegion
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static CLBufferRegion.Buffer malloc(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static CLBufferRegion.Buffer calloc(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static CLBufferRegion.Buffer create(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static CLBufferRegion.Buffer create(long address, int capacity)
Create aCLBufferRegion.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static CLBufferRegion mallocStack()
Returns a newCLBufferRegion
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static CLBufferRegion callocStack()
Returns a newCLBufferRegion
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static CLBufferRegion mallocStack(MemoryStack stack)
Returns a newCLBufferRegion
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static CLBufferRegion callocStack(MemoryStack stack)
Returns a newCLBufferRegion
instance allocated on the specifiedMemoryStack
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 newCLBufferRegion.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static CLBufferRegion.Buffer callocStack(int capacity)
Returns a newCLBufferRegion.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static CLBufferRegion.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newCLBufferRegion.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static CLBufferRegion.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newCLBufferRegion.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-