Class SDL_CursorFrameInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_CursorFrameInfo>

org.lwjgl.sdl.SDL_CursorFrameInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_CursorFrameInfo
extends Struct<SDL_CursorFrameInfo>
implements NativeResource

struct SDL_CursorFrameInfo {
    SDL_Surface * surface;
    Uint32 duration;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_CursorFrameInfo.Buffer	An array of SDL_CursorFrameInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DURATION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SURFACE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
SDL_CursorFrameInfo(ByteBuffer container)	Creates a SDL_CursorFrameInfo instance at the current position of the specified ByteBuffer container.

Method Summary

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

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

SURFACE

public static final int SURFACE

The struct member offsets.

DURATION

public static final int DURATION

The struct member offsets.

Constructor Details

SDL_CursorFrameInfo

public SDL_CursorFrameInfo(ByteBuffer container)

Creates a SDL_CursorFrameInfo 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_CursorFrameInfo>

surface

@NativeType("SDL_Surface *")
public SDL_Surface surface()

Returns:

a SDL_Surface view of the struct pointed to by the surface field.

duration

@NativeType("Uint32")
public int duration()

Returns:

the value of the duration field.

surface

public SDL_CursorFrameInfo surface(@NativeType("SDL_Surface *")
 SDL_Surface value)

Sets the address of the specified SDL_Surface to the surface field.

duration

public SDL_CursorFrameInfo duration(@NativeType("Uint32")
 int value)

Sets the specified value to the duration field.

set

public SDL_CursorFrameInfo set(SDL_Surface surface,
 int duration)

Initializes this struct with the specified values.

set

public SDL_CursorFrameInfo set(SDL_CursorFrameInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_CursorFrameInfo malloc()

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

calloc

public static SDL_CursorFrameInfo calloc()

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

create

public static SDL_CursorFrameInfo create()

Returns a new SDL_CursorFrameInfo instance allocated with BufferUtils.

create

public static SDL_CursorFrameInfo create(long address)

Returns a new SDL_CursorFrameInfo instance for the specified memory address.

createSafe

public static @Nullable SDL_CursorFrameInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_CursorFrameInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SDL_CursorFrameInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SDL_CursorFrameInfo.Buffer create(int capacity)

Returns a new SDL_CursorFrameInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a SDL_CursorFrameInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static SDL_CursorFrameInfo malloc(MemoryStack stack)

Returns a new SDL_CursorFrameInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_CursorFrameInfo calloc(MemoryStack stack)

Returns a new SDL_CursorFrameInfo 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_CursorFrameInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsurface

public static SDL_Surface nsurface(long struct)

Unsafe version of surface().

nduration

public static int nduration(long struct)

Unsafe version of duration().

nsurface

public static void nsurface(long struct,
 SDL_Surface value)

Unsafe version of surface.

nduration

public static void nduration(long struct,
 int value)

Unsafe version of duration.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate