Modifier and Type	Class and Description
public static class	CLBufferRegion.Buffer An array of `CLBufferRegion` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ORIGIN The struct member offsets.
public static final int	SIZE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	CLBufferRegion(long address, ByteBuffer container)
public	CLBufferRegion(ByteBuffer container) Creates a `CLBufferRegion` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static CLBufferRegion	calloc() Returns a new `CLBufferRegion` instance allocated with `memCalloc`.
public static CLBufferRegion.Buffer	calloc(int the buffer capacity capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `memCalloc`.
public static CLBufferRegion	calloc(MemoryStack the stack from which to allocate stack) Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static CLBufferRegion.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static CLBufferRegion	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected CLBufferRegion	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 CLBufferRegion	create() Returns a new `CLBufferRegion` instance allocated with `BufferUtils`.
public static CLBufferRegion	create(long address) Returns a new `CLBufferRegion` instance for the specified memory address.
public static CLBufferRegion.Buffer	create(int the buffer capacity capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `BufferUtils`.
public static CLBufferRegion.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `CLBufferRegion.Buffer` instance at the specified memory.
public static CLBufferRegion	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static CLBufferRegion.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static CLBufferRegion	malloc() Returns a new `CLBufferRegion` instance allocated with `memAlloc`.
public static CLBufferRegion.Buffer	malloc(int the buffer capacity capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `memAlloc`.
public static CLBufferRegion	malloc(MemoryStack the stack from which to allocate stack) Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack`.
public static CLBufferRegion.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack`.
public static CLBufferRegion	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static CLBufferRegion.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	norigin(long struct) Unsafe version of `origin`.
public static void	norigin(long struct, long value) Unsafe version of `origin`.
public static long	nsize(long struct) Unsafe version of `size`.
public static void	nsize(long struct, long value) Unsafe version of `size`.
public long	origin() the region offset, in bytes
public CLBufferRegion	origin(long value) Sets the specified value to the `origin` field.
public CLBufferRegion	set(long origin, long size) Initializes this struct with the specified values.
public CLBufferRegion	Returns: this struct set(CLBufferRegion the source struct src) Copies the specified struct data to this struct.
public long	size() the region size, in bytes
public CLBufferRegion	size(long value) Sets the specified value to the `size` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

ORIGIN	back to summary
public static final int ORIGIN The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

CLBufferRegion	back to summary
protected CLBufferRegion(long address, ByteBuffer container)

CLBufferRegion back to summary

CLBufferRegion	back to summary
public CLBufferRegion(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.

public CLBufferRegion(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

calloc	back to summary
public static CLBufferRegion calloc() Returns a new `CLBufferRegion` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static CLBufferRegion.Buffer calloc(int capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static CLBufferRegion.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static CLBufferRegion calloc(MemoryStack stack) Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static CLBufferRegion calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static CLBufferRegion.Buffer calloc(int capacity, MemoryStack stack) Returns a new `CLBufferRegion.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

public static CLBufferRegion.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CLBufferRegion.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

callocStack back to summary

callocStack	back to summary
public static CLBufferRegion callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLBufferRegion callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLBufferRegion.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static CLBufferRegion.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected CLBufferRegion 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

protected CLBufferRegion 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

create	back to summary
public static CLBufferRegion create() Returns a new `CLBufferRegion` instance allocated with `BufferUtils`.

create	back to summary
public static CLBufferRegion create(long address) Returns a new `CLBufferRegion` instance for the specified memory address.

create back to summary

create	back to summary
public static CLBufferRegion.Buffer create(int capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static CLBufferRegion.Buffer create(int capacity)

Returns a new CLBufferRegion.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static CLBufferRegion.Buffer create(long address, int capacity) Create a `CLBufferRegion.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static CLBufferRegion.Buffer create(long address, int capacity)

Create a CLBufferRegion.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static CLBufferRegion createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static CLBufferRegion createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static CLBufferRegion.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static CLBufferRegion malloc() Returns a new `CLBufferRegion` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static CLBufferRegion.Buffer malloc(int capacity) Returns a new `CLBufferRegion.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static CLBufferRegion.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static CLBufferRegion malloc(MemoryStack stack) Returns a new `CLBufferRegion` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static CLBufferRegion malloc(MemoryStack stack)

Returns a new CLBufferRegion instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static CLBufferRegion.Buffer malloc(int capacity, MemoryStack stack) Returns a new `CLBufferRegion.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static CLBufferRegion.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static CLBufferRegion mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLBufferRegion mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLBufferRegion.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static CLBufferRegion.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static CLBufferRegion.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

norigin	back to summary
public static long norigin(long struct) Unsafe version of `origin`.

norigin	back to summary
public static void norigin(long struct, long value) Unsafe version of `origin`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

nsize	back to summary
public static void nsize(long struct, long value) Unsafe version of `size`.

origin	back to summary
public long origin() the region offset, in bytes Annotations @NativeType:size_t

origin

back to summary

public long origin()

the region offset, in bytes

Annotations

@NativeType:size_t

origin	back to summary
public CLBufferRegion origin(long value) Sets the specified value to the `origin` field.

set	back to summary
public CLBufferRegion set(long origin, long size) Initializes this struct with the specified values.

set	back to summary
public CLBufferRegion set(CLBufferRegion src) Copies the specified struct data to this struct. Parameters src:CLBufferRegion the source struct Returns:CLBufferRegion this struct

set

back to summary

public CLBufferRegion set(CLBufferRegion src)

Copies the specified struct data to this struct.

Parameters

src:CLBufferRegion: the source struct

Returns:CLBufferRegion

this struct

size	back to summary
public long size() the region size, in bytes Annotations @NativeType:size_t

size

back to summary

public long size()

the region size, in bytes

Annotations

@NativeType:size_t

size	back to summary
public CLBufferRegion size(long value) Sets the specified value to the `size` field.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

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 CLBufferRegion.Buffer

Class Inheritance

extends StructBuffer<CLBufferRegion, CLBufferRegion.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CLBufferRegion structs.

Field Summary

Modifier and Type	Field and Description
private static final CLBufferRegion	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `CLBufferRegion.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 Type	Method and Description
protected CLBufferRegion	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `CLBufferRegion#origin` field. origin()
public CLBufferRegion.Buffer	origin(long value) Sets the specified value to the `CLBufferRegion#origin` field.
protected CLBufferRegion.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `CLBufferRegion#size` field. size()
public CLBufferRegion.Buffer	size(long value) Sets the specified value to the `CLBufferRegion#size` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final CLBufferRegion ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `CLBufferRegion.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 `CLBufferRegion#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new CLBufferRegion.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 CLBufferRegion#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected CLBufferRegion getElementFactory()

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

Annotations

@Override

origin	back to summary
public long origin() Returns:long the value of the `CLBufferRegion#origin` field. Annotations @NativeType:size_t

origin	back to summary
public CLBufferRegion.Buffer origin(long value) Sets the specified value to the `CLBufferRegion#origin` field.

self

back to summary

protected CLBufferRegion.Buffer self()

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

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `CLBufferRegion#size` field. Annotations @NativeType:size_t

size	back to summary
public CLBufferRegion.Buffer size(long value) Sets the specified value to the `CLBufferRegion#size` field.

public Class CLBufferRegion

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CLBufferRegion.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail