Class ExrDeepScanlineRequest

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ExrDeepScanlineRequest>

org.lwjgl.util.tinyexr.ExrDeepScanlineRequest

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class ExrDeepScanlineRequest
extends Struct<ExrDeepScanlineRequest>
implements NativeResource

struct ExrDeepScanlineRequest {
    ExrPart part;
    int32_t y_start;
    int32_t num_lines;
    ExrDeepSampleInfo * sample_info;
    ExrBuffer output;
    uint32_t channels_mask;
    uint32_t output_pixel_type;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExrDeepScanlineRequest.Buffer	An array of ExrDeepScanlineRequest 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	CHANNELS_MASK	The struct member offsets.
static final int	NUM_LINES	The struct member offsets.
static final int	OUTPUT	The struct member offsets.
static final int	OUTPUT_PIXEL_TYPE	The struct member offsets.
static final int	PART	The struct member offsets.
static final int	SAMPLE_INFO	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	Y_START	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ExrDeepScanlineRequest	calloc()	Returns a new ExrDeepScanlineRequest instance allocated with memCalloc.
static ExrDeepScanlineRequest.Buffer	calloc(int capacity)	Returns a new ExrDeepScanlineRequest.Buffer instance allocated with memCalloc.
static ExrDeepScanlineRequest.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new ExrDeepScanlineRequest.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ExrDeepScanlineRequest	calloc(MemoryStack stack)	Returns a new ExrDeepScanlineRequest instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	channels_mask()
ExrDeepScanlineRequest	channels_mask(int value)	Sets the specified value to the channels_mask field.
static ExrDeepScanlineRequest	create()	Returns a new ExrDeepScanlineRequest instance allocated with BufferUtils.
static ExrDeepScanlineRequest.Buffer	create(int capacity)	Returns a new ExrDeepScanlineRequest.Buffer instance allocated with BufferUtils.
static ExrDeepScanlineRequest	create(long address)	Returns a new ExrDeepScanlineRequest instance for the specified memory address.
static ExrDeepScanlineRequest.Buffer	create(long address, int capacity)	Create a ExrDeepScanlineRequest.Buffer instance at the specified memory.
static @Nullable ExrDeepScanlineRequest	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ExrDeepScanlineRequest.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static ExrDeepScanlineRequest	malloc()	Returns a new ExrDeepScanlineRequest instance allocated with memAlloc.
static ExrDeepScanlineRequest.Buffer	malloc(int capacity)	Returns a new ExrDeepScanlineRequest.Buffer instance allocated with memAlloc.
static ExrDeepScanlineRequest.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new ExrDeepScanlineRequest.Buffer instance allocated on the specified MemoryStack.
static ExrDeepScanlineRequest	malloc(MemoryStack stack)	Returns a new ExrDeepScanlineRequest instance allocated on the specified MemoryStack.
static int	nchannels_mask(long struct)	Unsafe version of channels_mask().
static void	nchannels_mask(long struct, int value)	Unsafe version of channels_mask.
static int	nnum_lines(long struct)	Unsafe version of num_lines().
static void	nnum_lines(long struct, int value)	Unsafe version of num_lines.
static ExrBuffer	noutput(long struct)	Unsafe version of output().
static void	noutput(long struct, ExrBuffer value)	Unsafe version of output.
static int	noutput_pixel_type(long struct)	Unsafe version of output_pixel_type().
static void	noutput_pixel_type(long struct, int value)	Unsafe version of output_pixel_type.
static long	npart(long struct)	Unsafe version of part().
static void	npart(long struct, long value)	Unsafe version of part.
static ExrDeepSampleInfo	nsample_info(long struct)	Unsafe version of sample_info().
static void	nsample_info(long struct, ExrDeepSampleInfo value)	Unsafe version of sample_info.
int	num_lines()
ExrDeepScanlineRequest	num_lines(int value)	Sets the specified value to the num_lines field.
static int	ny_start(long struct)	Unsafe version of y_start().
static void	ny_start(long struct, int value)	Unsafe version of y_start.
ExrBuffer	output()
ExrDeepScanlineRequest	output(Consumer<ExrBuffer> consumer)	Passes the output field to the specified Consumer.
ExrDeepScanlineRequest	output(ExrBuffer value)	Copies the specified ExrBuffer to the output field.
int	output_pixel_type()
ExrDeepScanlineRequest	output_pixel_type(int value)	Sets the specified value to the output_pixel_type field.
long	part()
ExrDeepScanlineRequest	part(long value)	Sets the specified value to the part field.
ExrDeepSampleInfo	sample_info()
ExrDeepScanlineRequest	sample_info(ExrDeepSampleInfo value)	Sets the address of the specified ExrDeepSampleInfo to the sample_info field.
ExrDeepScanlineRequest	set(long part, int y_start, int num_lines, ExrDeepSampleInfo sample_info, ExrBuffer output, int channels_mask, int output_pixel_type)	Initializes this struct with the specified values.
ExrDeepScanlineRequest	set(ExrDeepScanlineRequest 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.
int	y_start()
ExrDeepScanlineRequest	y_start(int value)	Sets the specified value to the y_start field.

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.

PART

public static final int PART

The struct member offsets.

Y_START

public static final int Y_START

The struct member offsets.

NUM_LINES

public static final int NUM_LINES

The struct member offsets.

SAMPLE_INFO

public static final int SAMPLE_INFO

The struct member offsets.

OUTPUT

public static final int OUTPUT

The struct member offsets.

CHANNELS_MASK

public static final int CHANNELS_MASK

The struct member offsets.

OUTPUT_PIXEL_TYPE

public static final int OUTPUT_PIXEL_TYPE

The struct member offsets.

Constructor Details

ExrDeepScanlineRequest

public ExrDeepScanlineRequest(ByteBuffer container)

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

part

@NativeType("ExrPart")
public long part()

Returns:

the value of the part field.

y_start

@NativeType("int32_t")
public int y_start()

Returns:

the value of the y_start field.

num_lines

@NativeType("int32_t")
public int num_lines()

Returns:

the value of the num_lines field.

sample_info

@NativeType("ExrDeepSampleInfo *")
public ExrDeepSampleInfo sample_info()

Returns:

a ExrDeepSampleInfo view of the struct pointed to by the sample_info field.

output

public ExrBuffer output()

Returns:

a ExrBuffer view of the output field.

channels_mask

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

Returns:

the value of the channels_mask field.

output_pixel_type

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

Returns:

the value of the output_pixel_type field.

part

public ExrDeepScanlineRequest part(@NativeType("ExrPart")
 long value)

Sets the specified value to the part field.

y_start

public ExrDeepScanlineRequest y_start(@NativeType("int32_t")
 int value)

Sets the specified value to the y_start field.

num_lines

public ExrDeepScanlineRequest num_lines(@NativeType("int32_t")
 int value)

Sets the specified value to the num_lines field.

sample_info

public ExrDeepScanlineRequest sample_info(@NativeType("ExrDeepSampleInfo *")
 ExrDeepSampleInfo value)

Sets the address of the specified ExrDeepSampleInfo to the sample_info field.

output

public ExrDeepScanlineRequest output(ExrBuffer value)

Copies the specified ExrBuffer to the output field.

output

public ExrDeepScanlineRequest output(Consumer<ExrBuffer> consumer)

Passes the output field to the specified Consumer.

channels_mask

public ExrDeepScanlineRequest channels_mask(@NativeType("uint32_t")
 int value)

Sets the specified value to the channels_mask field.

output_pixel_type

public ExrDeepScanlineRequest output_pixel_type(@NativeType("uint32_t")
 int value)

Sets the specified value to the output_pixel_type field.

set

public ExrDeepScanlineRequest set(long part,
 int y_start,
 int num_lines,
 ExrDeepSampleInfo sample_info,
 ExrBuffer output,
 int channels_mask,
 int output_pixel_type)

Initializes this struct with the specified values.

set

public ExrDeepScanlineRequest set(ExrDeepScanlineRequest src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ExrDeepScanlineRequest malloc()

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

calloc

public static ExrDeepScanlineRequest calloc()

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

create

public static ExrDeepScanlineRequest create()

Returns a new ExrDeepScanlineRequest instance allocated with BufferUtils.

create

public static ExrDeepScanlineRequest create(long address)

Returns a new ExrDeepScanlineRequest instance for the specified memory address.

createSafe

public static @Nullable ExrDeepScanlineRequest createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ExrDeepScanlineRequest.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static ExrDeepScanlineRequest.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static ExrDeepScanlineRequest.Buffer create(int capacity)

Returns a new ExrDeepScanlineRequest.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a ExrDeepScanlineRequest.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static ExrDeepScanlineRequest malloc(MemoryStack stack)

Returns a new ExrDeepScanlineRequest instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static ExrDeepScanlineRequest calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npart

public static long npart(long struct)

Unsafe version of part().

ny_start

public static int ny_start(long struct)

Unsafe version of y_start().

nnum_lines

public static int nnum_lines(long struct)

Unsafe version of num_lines().

nsample_info

public static ExrDeepSampleInfo nsample_info(long struct)

Unsafe version of sample_info().

noutput

public static ExrBuffer noutput(long struct)

Unsafe version of output().

nchannels_mask

public static int nchannels_mask(long struct)

Unsafe version of channels_mask().

noutput_pixel_type

public static int noutput_pixel_type(long struct)

Unsafe version of output_pixel_type().

npart

public static void npart(long struct,
 long value)

Unsafe version of part.

ny_start

public static void ny_start(long struct,
 int value)

Unsafe version of y_start.

nnum_lines

public static void nnum_lines(long struct,
 int value)

Unsafe version of num_lines.

nsample_info

public static void nsample_info(long struct,
 ExrDeepSampleInfo value)

Unsafe version of sample_info.

noutput

public static void noutput(long struct,
 ExrBuffer value)

Unsafe version of output.

nchannels_mask

public static void nchannels_mask(long struct,
 int value)

Unsafe version of channels_mask.

noutput_pixel_type

public static void noutput_pixel_type(long struct,
 int value)

Unsafe version of output_pixel_type.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate