org.lwjgl.opencl.CLBufferRegion

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class CLBufferRegion extends Struct<CLBufferRegion> implements NativeResource


 struct cl_buffer_region {
     size_t origin;
     size_t size;
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

CLBufferRegion.Buffer

An array of CLBufferRegion structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

ORIGIN

The struct member offsets.

static final int

SIZE

The struct member offsets.

static final 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

Description

CLBufferRegion(ByteBuffer container)

Creates a CLBufferRegion instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

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

calloc(int capacity, MemoryStack stack)

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

static CLBufferRegion

calloc(MemoryStack stack)

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

static CLBufferRegion

callocStack()

Deprecated.

static CLBufferRegion.Buffer

callocStack(int capacity)

Deprecated.

static CLBufferRegion.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static CLBufferRegion

callocStack(MemoryStack stack)

Deprecated.

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 @Nullable CLBufferRegion

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable 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.Buffer

malloc(int capacity, MemoryStack stack)

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

static CLBufferRegion

malloc(MemoryStack stack)

Returns a new CLBufferRegion instance allocated on the specified MemoryStack.

static CLBufferRegion

mallocStack()

Deprecated.

static CLBufferRegion.Buffer

mallocStack(int capacity)

Deprecated.

static CLBufferRegion.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static CLBufferRegion

mallocStack(MemoryStack stack)

Deprecated.

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()

CLBufferRegion

origin(long value)

Sets the specified value to the origin field.

CLBufferRegion

set(long origin, long size)

Initializes this struct with the specified values.

CLBufferRegion

set(CLBufferRegion src)

Copies the specified struct data to this struct.

long

size()

CLBufferRegion

size(long value)

Sets the specified value to the size field.

int

sizeof()

Returns sizeof(struct).

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

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 Details
- 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 Details
- CLBufferRegion
  
  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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<CLBufferRegion>
- 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
  
  public static @Nullable 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
  
  public static @Nullable CLBufferRegion.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static CLBufferRegion mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static CLBufferRegion callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static CLBufferRegion mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static CLBufferRegion callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static CLBufferRegion.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static CLBufferRegion.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static CLBufferRegion.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static CLBufferRegion.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static CLBufferRegion malloc(MemoryStack stack)
  
  Returns a new CLBufferRegion instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  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 - the stack from which to allocate
- malloc
  
  public static CLBufferRegion.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new CLBufferRegion.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  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 - the buffer capacity
  
  stack - the stack from which to allocate
- 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

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

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 Details

SIZEOF

ALIGNOF

ORIGIN

SIZE

Constructor Details

CLBufferRegion

Method Details

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

malloc

calloc

malloc

calloc

norigin

nsize

norigin

nsize