Top Description Inners Fields Constructors Methods
org.lwjgl.util.tinyexr

public Class EXRHeader

extends Struct<EXRHeader>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct EXRHeader {
    float pixel_aspect_ratio;
    int line_order;
    EXRBox2i data_window;
    EXRBox2i display_window;
    float screen_window_center[2];
    float screen_window_width;
    int chunk_count;
    int tiled;
    int tile_size_x;
    int tile_size_y;
    int tile_level_mode;
    int tile_rounding_mode;
    int long_name;
    int non_image;
    int multipart;
    unsigned int header_len;
    int num_custom_attributes;
    EXRAttribute * custom_attributes;
    EXRChannelInfo * channels;
    int * pixel_types;
    int num_channels;
    int compression_type;
    int * requested_pixel_types;
    char name[256];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
EXRHeader.Buffer

An array of EXRHeader structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHANNELS

The struct member offsets.

public static final int
CHUNK_COUNT

The struct member offsets.

public static final int
COMPRESSION_TYPE

The struct member offsets.

public static final int
CUSTOM_ATTRIBUTES

The struct member offsets.

public static final int
DATA_WINDOW

The struct member offsets.

public static final int
DISPLAY_WINDOW

The struct member offsets.

public static final int
HEADER_LEN

The struct member offsets.

public static final int
LINE_ORDER

The struct member offsets.

public static final int
LONG_NAME

The struct member offsets.

public static final int
MULTIPART

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
NON_IMAGE

The struct member offsets.

public static final int
NUM_CHANNELS

The struct member offsets.

public static final int
NUM_CUSTOM_ATTRIBUTES

The struct member offsets.

public static final int
PIXEL_ASPECT_RATIO

The struct member offsets.

public static final int
PIXEL_TYPES

The struct member offsets.

public static final int
REQUESTED_PIXEL_TYPES

The struct member offsets.

public static final int
SCREEN_WINDOW_CENTER

The struct member offsets.

public static final int
SCREEN_WINDOW_WIDTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TILE_LEVEL_MODE

The struct member offsets.

public static final int
TILE_ROUNDING_MODE

The struct member offsets.

public static final int
TILE_SIZE_X

The struct member offsets.

public static final int
TILE_SIZE_Y

The struct member offsets.

public static final int
TILED

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
EXRHeader(long address, ByteBuffer container)

public
EXRHeader(ByteBuffer container)

Creates a EXRHeader instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static EXRHeader
calloc()

Returns a new EXRHeader instance allocated with memCalloc.

public static EXRHeader.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new EXRHeader.Buffer instance allocated with memCalloc.

public static EXRHeader
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static EXRHeader.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static EXRHeader
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public EXRChannelInfo.Buffer

Returns:

a EXRChannelInfo.Buffer view of the struct array pointed to by the channels field.
channels()

public EXRHeader
channels(EXRChannelInfo.Buffer value)

Sets the address of the specified EXRChannelInfo.Buffer to the channels field.

public int

Returns:

the value of the chunk_count field.
chunk_count()

public EXRHeader
chunk_count(int value)

Sets the specified value to the chunk_count field.

public int
compression_type()

compression type (TINYEXR_COMPRESSIONTYPE_*)

public EXRHeader
compression_type(int value)

Sets the specified value to the compression_type field.

protected EXRHeader
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static EXRHeader
create()

Returns a new EXRHeader instance allocated with BufferUtils.

public static EXRHeader
create(long address)

Returns a new EXRHeader instance for the specified memory address.

public static EXRHeader.Buffer
create(int
the buffer capacity
capacity)

Returns a new EXRHeader.Buffer instance allocated with BufferUtils.

public static EXRHeader.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a EXRHeader.Buffer instance at the specified memory.

public static EXRHeader
createSafe(long address)

Like create, but returns null if address is NULL.

public static EXRHeader.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public EXRAttribute.Buffer
custom_attributes()

custom attributes (excludes required attributes, e.g. `channels`, `compression`, etc)

public EXRHeader
custom_attributes(EXRAttribute.Buffer value)

Sets the address of the specified EXRAttribute.Buffer to the custom_attributes field.

public EXRBox2i

Returns:

a EXRBox2i view of the data_window field.
data_window()

public EXRHeader
data_window(EXRBox2i value)

Copies the specified EXRBox2i to the data_window field.

public EXRHeader
data_window(Consumer<EXRBox2i> consumer)

Passes the data_window field to the specified Consumer.

public EXRBox2i

Returns:

a EXRBox2i view of the display_window field.
display_window()

public EXRHeader
display_window(EXRBox2i value)

Copies the specified EXRBox2i to the display_window field.

public EXRHeader
display_window(Consumer<EXRBox2i> consumer)

Passes the display_window field to the specified Consumer.

public int

Returns:

the value of the header_len field.
header_len()

public EXRHeader
header_len(int value)

Sets the specified value to the header_len field.

public int

Returns:

the value of the line_order field.
line_order()

public EXRHeader
line_order(int value)

Sets the specified value to the line_order field.

public boolean

Returns:

the value of the long_name field.
long_name()

public EXRHeader
long_name(boolean value)

Sets the specified value to the long_name field.

public static EXRHeader
malloc()

Returns a new EXRHeader instance allocated with memAlloc.

public static EXRHeader.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new EXRHeader.Buffer instance allocated with memAlloc.

public static EXRHeader
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new EXRHeader instance allocated on the specified MemoryStack.

public static EXRHeader.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static EXRHeader
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static EXRHeader.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public boolean

Returns:

the value of the multipart field.
multipart()

public EXRHeader
multipart(boolean value)

Sets the specified value to the multipart field.

public ByteBuffer
name()

Name attribute required for multipart files.

public EXRHeader
name(ByteBuffer value)

Copies the specified encoded string to the name field.

public String
nameString()

Name attribute required for multipart files.

public static EXRChannelInfo.Buffer
nchannels(long struct)

Unsafe version of channels.

public static void
nchannels(long struct, EXRChannelInfo.Buffer value)

Unsafe version of channels.

public static int
nchunk_count(long struct)

Unsafe version of chunk_count.

public static void
nchunk_count(long struct, int value)

Unsafe version of chunk_count.

public static int
ncompression_type(long struct)

Unsafe version of compression_type.

public static void
ncompression_type(long struct, int value)

Unsafe version of compression_type.

public static EXRAttribute.Buffer
ncustom_attributes(long struct)

Unsafe version of custom_attributes.

public static void
ncustom_attributes(long struct, EXRAttribute.Buffer value)

Unsafe version of custom_attributes.

public static EXRBox2i
ndata_window(long struct)

Unsafe version of data_window.

public static void
ndata_window(long struct, EXRBox2i value)

Unsafe version of data_window.

public static EXRBox2i
ndisplay_window(long struct)

Unsafe version of display_window.

public static void
ndisplay_window(long struct, EXRBox2i value)

Unsafe version of display_window.

public static int
nheader_len(long struct)

Unsafe version of header_len.

public static void
nheader_len(long struct, int value)

Unsafe version of header_len.

public static int
nline_order(long struct)

Unsafe version of line_order.

public static void
nline_order(long struct, int value)

Unsafe version of line_order.

public static int
nlong_name(long struct)

Unsafe version of long_name.

public static void
nlong_name(long struct, int value)

Unsafe version of long_name.

public static int
nmultipart(long struct)

Unsafe version of multipart.

public static void
nmultipart(long struct, int value)

Unsafe version of multipart.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, ByteBuffer value)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static int
nnon_image(long struct)

Unsafe version of non_image.

public static void
nnon_image(long struct, int value)

Unsafe version of non_image.

public static int
nnum_channels(long struct)

Unsafe version of num_channels.

public static void
nnum_channels(long struct, int value)

Sets the specified value to the num_channels field of the specified struct.

public static int
nnum_custom_attributes(long struct)

Unsafe version of num_custom_attributes.

public static void
nnum_custom_attributes(long struct, int value)

Sets the specified value to the num_custom_attributes field of the specified struct.

public boolean
non_image()

For a single-part file, agree with the version field bit 11.

public EXRHeader
non_image(boolean value)

Sets the specified value to the non_image field.

public static float
npixel_aspect_ratio(long struct)

Unsafe version of pixel_aspect_ratio.

public static void
npixel_aspect_ratio(long struct, float value)

Unsafe version of pixel_aspect_ratio.

public static IntBuffer
npixel_types(long struct)

Unsafe version of pixel_types.

public static void
npixel_types(long struct, IntBuffer value)

Unsafe version of pixel_types.

public static IntBuffer
nrequested_pixel_types(long struct)

Unsafe version of requested_pixel_types.

public static void
nrequested_pixel_types(long struct, IntBuffer value)

Unsafe version of requested_pixel_types.

public static FloatBuffer
nscreen_window_center(long struct)

Unsafe version of screen_window_center.

public static float
nscreen_window_center(long struct, int index)

Unsafe version of screen_window_center.

public static void
nscreen_window_center(long struct, FloatBuffer value)

Unsafe version of screen_window_center.

public static void
nscreen_window_center(long struct, int index, float value)

Unsafe version of screen_window_center.

public static float
nscreen_window_width(long struct)

Unsafe version of screen_window_width.

public static void
nscreen_window_width(long struct, float value)

Unsafe version of screen_window_width.

public static int
ntile_level_mode(long struct)

Unsafe version of tile_level_mode.

public static void
ntile_level_mode(long struct, int value)

Unsafe version of tile_level_mode.

public static int
ntile_rounding_mode(long struct)

Unsafe version of tile_rounding_mode.

public static void
ntile_rounding_mode(long struct, int value)

Unsafe version of tile_rounding_mode.

public static int
ntile_size_x(long struct)

Unsafe version of tile_size_x.

public static void
ntile_size_x(long struct, int value)

Unsafe version of tile_size_x.

public static int
ntile_size_y(long struct)

Unsafe version of tile_size_y.

public static void
ntile_size_y(long struct, int value)

Unsafe version of tile_size_y.

public static int
ntiled(long struct)

Unsafe version of tiled.

public static void
ntiled(long struct, int value)

Unsafe version of tiled.

public int

Returns:

the value of the num_channels field.
num_channels()

public EXRHeader
num_channels(int value)

Sets the specified value to the num_channels field.

public int
num_custom_attributes()

number of EXRAttribute in the custom_attributes array

public EXRHeader
num_custom_attributes(int value)

Sets the specified value to the num_custom_attributes field.

public float

Returns:

the value of the pixel_aspect_ratio field.
pixel_aspect_ratio()

public EXRHeader
pixel_aspect_ratio(float value)

Sets the specified value to the pixel_aspect_ratio field.

public IntBuffer
pixel_types()

loaded pixel type (TINYEXR_PIXELTYPE_*) of images for each channel.

public EXRHeader
pixel_types(IntBuffer value)

Sets the address of the specified IntBuffer to the pixel_types field.

public IntBuffer
requested_pixel_types()

filled initially by ParseEXRHeaderFrom(Memory|File), then users can edit it (only valid for HALF pixel type channel)

public EXRHeader
requested_pixel_types(IntBuffer value)

Sets the address of the specified IntBuffer to the requested_pixel_types field.

public FloatBuffer

Returns:

a FloatBuffer view of the screen_window_center field.
screen_window_center()

public float

Returns:

the value at the specified index of the screen_window_center field.
screen_window_center(int index)

public EXRHeader
screen_window_center(FloatBuffer value)

Copies the specified FloatBuffer to the screen_window_center field.

public EXRHeader
screen_window_center(int index, float value)

Sets the specified value at the specified index of the screen_window_center field.

public float

Returns:

the value of the screen_window_width field.
screen_window_width()

public EXRHeader
screen_window_width(float value)

Sets the specified value to the screen_window_width field.

public EXRHeader
set(float pixel_aspect_ratio, int line_order, EXRBox2i data_window, EXRBox2i display_window, FloatBuffer screen_window_center, float screen_window_width, int chunk_count, boolean tiled, int tile_size_x, int tile_size_y, int tile_level_mode, int tile_rounding_mode, boolean long_name, boolean non_image, boolean multipart, int header_len, int num_custom_attributes, EXRAttribute.Buffer custom_attributes, EXRChannelInfo.Buffer channels, IntBuffer pixel_types, int num_channels, int compression_type, IntBuffer requested_pixel_types, ByteBuffer name)

Initializes this struct with the specified values.

public EXRHeader

Returns:

this struct
set(EXRHeader
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int

Returns:

the value of the tile_level_mode field.
tile_level_mode()

public EXRHeader
tile_level_mode(int value)

Sets the specified value to the tile_level_mode field.

public int

Returns:

the value of the tile_rounding_mode field.
tile_rounding_mode()

public EXRHeader
tile_rounding_mode(int value)

Sets the specified value to the tile_rounding_mode field.

public int

Returns:

the value of the tile_size_x field.
tile_size_x()

public EXRHeader
tile_size_x(int value)

Sets the specified value to the tile_size_x field.

public int

Returns:

the value of the tile_size_y field.
tile_size_y()

public EXRHeader
tile_size_y(int value)

Sets the specified value to the tile_size_y field.

public boolean

Returns:

the value of the tiled field.
tiled()

public EXRHeader
tiled(boolean value)

Sets the specified value to the tiled field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate