Class ExrEncoderCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ExrEncoderCreateInfo>

org.lwjgl.util.tinyexr.ExrEncoderCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ExrEncoderCreateInfo
extends Struct<ExrEncoderCreateInfo>
implements NativeResource

struct ExrEncoderCreateInfo {
    ExrDataSink sink;
    ExrMemoryPool scratch_pool;
    uint32_t flags;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExrEncoderCreateInfo.Buffer	An array of ExrEncoderCreateInfo 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	FLAGS	The struct member offsets.
static final int	SCRATCH_POOL	The struct member offsets.
static final int	SINK	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ExrEncoderCreateInfo	calloc()	Returns a new ExrEncoderCreateInfo instance allocated with memCalloc.
static ExrEncoderCreateInfo.Buffer	calloc(int capacity)	Returns a new ExrEncoderCreateInfo.Buffer instance allocated with memCalloc.
static ExrEncoderCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ExrEncoderCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ExrEncoderCreateInfo	calloc(MemoryStack stack)	Returns a new ExrEncoderCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ExrEncoderCreateInfo	create()	Returns a new ExrEncoderCreateInfo instance allocated with BufferUtils.
static ExrEncoderCreateInfo.Buffer	create(int capacity)	Returns a new ExrEncoderCreateInfo.Buffer instance allocated with BufferUtils.
static ExrEncoderCreateInfo	create(long address)	Returns a new ExrEncoderCreateInfo instance for the specified memory address.
static ExrEncoderCreateInfo.Buffer	create(long address, int capacity)	Create a ExrEncoderCreateInfo.Buffer instance at the specified memory.
static @Nullable ExrEncoderCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ExrEncoderCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
ExrEncoderCreateInfo	flags(int value)	Sets the specified value to the flags field.
static ExrEncoderCreateInfo	malloc()	Returns a new ExrEncoderCreateInfo instance allocated with memAlloc.
static ExrEncoderCreateInfo.Buffer	malloc(int capacity)	Returns a new ExrEncoderCreateInfo.Buffer instance allocated with memAlloc.
static ExrEncoderCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ExrEncoderCreateInfo.Buffer instance allocated on the specified MemoryStack.
static ExrEncoderCreateInfo	malloc(MemoryStack stack)	Returns a new ExrEncoderCreateInfo instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	nscratch_pool(long struct)	Unsafe version of scratch_pool().
static void	nscratch_pool(long struct, long value)	Unsafe version of scratch_pool.
static ExrDataSink	nsink(long struct)	Unsafe version of sink().
static void	nsink(long struct, ExrDataSink value)	Unsafe version of sink.
long	scratch_pool()
ExrEncoderCreateInfo	scratch_pool(long value)	Sets the specified value to the scratch_pool field.
ExrEncoderCreateInfo	set(ExrDataSink sink, long scratch_pool, int flags)	Initializes this struct with the specified values.
ExrEncoderCreateInfo	set(ExrEncoderCreateInfo src)	Copies the specified struct data to this struct.
ExrDataSink	sink()
ExrEncoderCreateInfo	sink(Consumer<ExrDataSink> consumer)	Passes the sink field to the specified Consumer.
ExrEncoderCreateInfo	sink(ExrDataSink value)	Copies the specified ExrDataSink to the sink field.
int	sizeof()	Returns sizeof(struct).
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.

SINK

public static final int SINK

The struct member offsets.

SCRATCH_POOL

public static final int SCRATCH_POOL

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

ExrEncoderCreateInfo

public ExrEncoderCreateInfo(ByteBuffer container)

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

sink

public ExrDataSink sink()

Returns:

a ExrDataSink view of the sink field.

scratch_pool

@NativeType("ExrMemoryPool")
public long scratch_pool()

Returns:

the value of the scratch_pool field.

flags

@NativeType("uint32_t")
public int flags()

Returns:

the value of the flags field.

sink

public ExrEncoderCreateInfo sink(ExrDataSink value)

Copies the specified ExrDataSink to the sink field.

sink

public ExrEncoderCreateInfo sink(Consumer<ExrDataSink> consumer)

Passes the sink field to the specified Consumer.

scratch_pool

public ExrEncoderCreateInfo scratch_pool(@NativeType("ExrMemoryPool")
 long value)

Sets the specified value to the scratch_pool field.

flags

public ExrEncoderCreateInfo flags(@NativeType("uint32_t")
 int value)

Sets the specified value to the flags field.

set

public ExrEncoderCreateInfo set(ExrDataSink sink,
 long scratch_pool,
 int flags)

Initializes this struct with the specified values.

set

public ExrEncoderCreateInfo set(ExrEncoderCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ExrEncoderCreateInfo malloc()

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

calloc

public static ExrEncoderCreateInfo calloc()

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

create

public static ExrEncoderCreateInfo create()

Returns a new ExrEncoderCreateInfo instance allocated with BufferUtils.

create

public static ExrEncoderCreateInfo create(long address)

Returns a new ExrEncoderCreateInfo instance for the specified memory address.

createSafe

public static @Nullable ExrEncoderCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ExrEncoderCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static ExrEncoderCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static ExrEncoderCreateInfo.Buffer create(int capacity)

Returns a new ExrEncoderCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a ExrEncoderCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static ExrEncoderCreateInfo malloc(MemoryStack stack)

Returns a new ExrEncoderCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static ExrEncoderCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsink

public static ExrDataSink nsink(long struct)

Unsafe version of sink().

nscratch_pool

public static long nscratch_pool(long struct)

Unsafe version of scratch_pool().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nsink

public static void nsink(long struct,
 ExrDataSink value)

Unsafe version of sink.

nscratch_pool

public static void nscratch_pool(long struct,
 long value)

Unsafe version of scratch_pool.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate