Package org.lwjgl.sdl

Class SDL_GPUBufferLocation

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_GPUBufferLocation>

org.lwjgl.sdl.SDL_GPUBufferLocation

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_GPUBufferLocation
extends Struct<SDL_GPUBufferLocation>
implements NativeResource

 struct SDL_GPUBufferLocation {
     SDL_GPUBuffer * buffer;
     Uint32 offset;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_GPUBufferLocation.Buffer	An array of SDL_GPUBufferLocation 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	BUFFER	The struct member offsets.
static final int	OFFSET	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
SDL_GPUBufferLocation(ByteBuffer container)	Creates a SDL_GPUBufferLocation instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	buffer()
SDL_GPUBufferLocation	buffer(long value)	Sets the specified value to the buffer field.
static SDL_GPUBufferLocation	calloc()	Returns a new SDL_GPUBufferLocation instance allocated with memCalloc.
static SDL_GPUBufferLocation.Buffer	calloc(int capacity)	Returns a new SDL_GPUBufferLocation.Buffer instance allocated with memCalloc.
static SDL_GPUBufferLocation.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUBufferLocation.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_GPUBufferLocation	calloc(MemoryStack stack)	Returns a new SDL_GPUBufferLocation instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_GPUBufferLocation	create()	Returns a new SDL_GPUBufferLocation instance allocated with BufferUtils.
static SDL_GPUBufferLocation.Buffer	create(int capacity)	Returns a new SDL_GPUBufferLocation.Buffer instance allocated with BufferUtils.
static SDL_GPUBufferLocation	create(long address)	Returns a new SDL_GPUBufferLocation instance for the specified memory address.
static SDL_GPUBufferLocation.Buffer	create(long address, int capacity)	Create a SDL_GPUBufferLocation.Buffer instance at the specified memory.
static @Nullable SDL_GPUBufferLocation	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_GPUBufferLocation.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static SDL_GPUBufferLocation	malloc()	Returns a new SDL_GPUBufferLocation instance allocated with memAlloc.
static SDL_GPUBufferLocation.Buffer	malloc(int capacity)	Returns a new SDL_GPUBufferLocation.Buffer instance allocated with memAlloc.
static SDL_GPUBufferLocation.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUBufferLocation.Buffer instance allocated on the specified MemoryStack.
static SDL_GPUBufferLocation	malloc(MemoryStack stack)	Returns a new SDL_GPUBufferLocation instance allocated on the specified MemoryStack.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static int	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, int value)	Unsafe version of offset.
int	offset()
SDL_GPUBufferLocation	offset(int value)	Sets the specified value to the offset field.
SDL_GPUBufferLocation	set(long buffer, int offset)	Initializes this struct with the specified values.
SDL_GPUBufferLocation	set(SDL_GPUBufferLocation src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

BUFFER

public static final int BUFFER

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

Constructor Details

SDL_GPUBufferLocation

public SDL_GPUBufferLocation(ByteBuffer container)

Creates a SDL_GPUBufferLocation 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<SDL_GPUBufferLocation>

buffer

public long buffer()

Returns:

the value of the buffer field.

offset

public int offset()

Returns:

the value of the offset field.

buffer

public SDL_GPUBufferLocation buffer(long value)

Sets the specified value to the buffer field.

offset

public SDL_GPUBufferLocation offset(int value)

Sets the specified value to the offset field.

set

public SDL_GPUBufferLocation set(long buffer,
 int offset)

Initializes this struct with the specified values.

set

public SDL_GPUBufferLocation set(SDL_GPUBufferLocation src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_GPUBufferLocation malloc()

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

calloc

public static SDL_GPUBufferLocation calloc()

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

create

public static SDL_GPUBufferLocation create()

Returns a new SDL_GPUBufferLocation instance allocated with BufferUtils.

create

public static SDL_GPUBufferLocation create(long address)

Returns a new SDL_GPUBufferLocation instance for the specified memory address.

createSafe

public static @Nullable SDL_GPUBufferLocation createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUBufferLocation.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SDL_GPUBufferLocation.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SDL_GPUBufferLocation.Buffer create(int capacity)

Returns a new SDL_GPUBufferLocation.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a SDL_GPUBufferLocation.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable SDL_GPUBufferLocation.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUBufferLocation malloc(MemoryStack stack)

Returns a new SDL_GPUBufferLocation instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_GPUBufferLocation calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

noffset

public static int noffset(long struct)

Unsafe version of offset().

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

noffset

public static void noffset(long struct,
 int value)

Unsafe version of offset.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate