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

public Class EXRImage

extends Struct<EXRImage>
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 EXRImage {
    EXRTile * tiles;
    struct _EXRImage * next_level;
    int level_x;
    int level_y;
    unsigned char ** images;
    int width;
    int height;
    int num_channels;
    int num_tiles;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
EXRImage.Buffer

An array of EXRImage structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HEIGHT

The struct member offsets.

public static final int
IMAGES

The struct member offsets.

public static final int
LEVEL_X

The struct member offsets.

public static final int
LEVEL_Y

The struct member offsets.

public static final int
NEXT_LEVEL

The struct member offsets.

public static final int
NUM_CHANNELS

The struct member offsets.

public static final int
NUM_TILES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TILES

The struct member offsets.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
EXRImage(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static EXRImage
calloc()

Returns a new EXRImage instance allocated with memCalloc.

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

Returns a new EXRImage.Buffer instance allocated with memCalloc.

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

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

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

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

public static EXRImage
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected EXRImage
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 EXRImage
create()

Returns a new EXRImage instance allocated with BufferUtils.

public static EXRImage
create(long address)

Returns a new EXRImage instance for the specified memory address.

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

Returns a new EXRImage.Buffer instance allocated with BufferUtils.

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

Create a EXRImage.Buffer instance at the specified memory.

public static EXRImage
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the height field.
height
()

public EXRImage
height(int value)

Sets the specified value to the height field.

public PointerBuffer
images()

image[channels][pixels].

public EXRImage
images(PointerBuffer value)

Sets the address of the specified PointerBuffer to the images field.

public int
level_x()

x level index

public EXRImage
level_x(int value)

Sets the specified value to the level_x field.

public int
level_y()

y level index

public EXRImage
level_y(int value)

Sets the specified value to the level_y field.

public static EXRImage
malloc()

Returns a new EXRImage instance allocated with memAlloc.

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

Returns a new EXRImage.Buffer instance allocated with memAlloc.

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

Returns a new EXRImage instance allocated on the specified MemoryStack.

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

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

public static EXRImage
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public EXRImage
next_level()

NULL if scanline format or image is the last level.

public EXRImage
next_level(EXRImage value)

Sets the address of the specified EXRImage to the next_level field.

public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static PointerBuffer
nimages(long struct)

Unsafe version of images.

public static void
nimages(long struct, PointerBuffer value)

Unsafe version of images.

public static int
nlevel_x(long struct)

Unsafe version of level_x.

public static void
nlevel_x(long struct, int value)

Unsafe version of level_x.

public static int
nlevel_y(long struct)

Unsafe version of level_y.

public static void
nlevel_y(long struct, int value)

Unsafe version of level_y.

public static EXRImage
nnext_level(long struct)

Unsafe version of next_level.

public static void
nnext_level(long struct, EXRImage value)

Unsafe version of next_level.

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_tiles(long struct)

Unsafe version of num_tiles.

public static void
nnum_tiles(long struct, int value)

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

public static EXRTile.Buffer
ntiles(long struct)

Unsafe version of tiles.

public static void
ntiles(long struct, EXRTile.Buffer value)

Unsafe version of tiles.

public int

Returns:

the value of the num_channels field.
num_channels
()

public EXRImage
num_channels(int value)

Sets the specified value to the num_channels field.

public int

Returns:

the value of the num_tiles field.
num_tiles
()

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public EXRImage
set(EXRTile.Buffer tiles, EXRImage next_level, int level_x, int level_y, PointerBuffer images, int width, int height, int num_channels)

Initializes this struct with the specified values.

public EXRImage

Returns:

this struct
set
(EXRImage
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 EXRTile.Buffer
tiles()

tiled pixel data.

public EXRImage
tiles(EXRTile.Buffer value)

Sets the address of the specified EXRTile.Buffer to the tiles field.

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

Validates pointer members that should not be NULL.

public int

Returns:

the value of the width field.
width
()

public EXRImage
width(int value)

Sets the specified value to the width field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

IMAGESback to summary
public static final int IMAGES

The struct member offsets.

LEVEL_Xback to summary
public static final int LEVEL_X

The struct member offsets.

LEVEL_Yback to summary
public static final int LEVEL_Y

The struct member offsets.

NEXT_LEVELback to summary
public static final int NEXT_LEVEL

The struct member offsets.

NUM_CHANNELSback to summary
public static final int NUM_CHANNELS

The struct member offsets.

NUM_TILESback to summary
public static final int NUM_TILES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TILESback to summary
public static final int TILES

The struct member offsets.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

EXRImageback to summary
protected EXRImage(long address, ByteBuffer container)
EXRImageback to summary
public EXRImage(ByteBuffer container)

Creates a EXRImage 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 Detail

callocback to summary
public static EXRImage calloc()

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

callocback to summary
public static EXRImage.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static EXRImage calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static EXRImage.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static EXRImage callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EXRImage callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EXRImage.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EXRImage.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected EXRImage create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static EXRImage create()

Returns a new EXRImage instance allocated with BufferUtils.

createback to summary
public static EXRImage create(long address)

Returns a new EXRImage instance for the specified memory address.

createback to summary
public static EXRImage.Buffer create(int capacity)

Returns a new EXRImage.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static EXRImage.Buffer create(long address, int capacity)

Create a EXRImage.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static EXRImage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static EXRImage.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
heightback to summary
public int height()
Returns:int

the value of the height field.

heightback to summary
public EXRImage height(int value)

Sets the specified value to the height field.

imagesback to summary
public PointerBuffer images()

image[channels][pixels]. NULL if tiled format.

Annotations
@Nullable
@NativeType:unsigned char **
imagesback to summary
public EXRImage images(PointerBuffer value)

Sets the address of the specified PointerBuffer to the images field.

level_xback to summary
public int level_x()

x level index

level_xback to summary
public EXRImage level_x(int value)

Sets the specified value to the level_x field.

level_yback to summary
public int level_y()

y level index

level_yback to summary
public EXRImage level_y(int value)

Sets the specified value to the level_y field.

mallocback to summary
public static EXRImage malloc()

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

mallocback to summary
public static EXRImage.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static EXRImage malloc(MemoryStack stack)

Returns a new EXRImage instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static EXRImage.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static EXRImage mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EXRImage mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EXRImage.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EXRImage.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
next_levelback to summary
public EXRImage next_level()

NULL if scanline format or image is the last level.

Annotations
@Nullable
@NativeType:struct _EXRImage *
next_levelback to summary
public EXRImage next_level(EXRImage value)

Sets the address of the specified EXRImage to the next_level field.

nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nheightback to summary
public static void nheight(long struct, int value)

Unsafe version of height.

nimagesback to summary
public static PointerBuffer nimages(long struct)

Unsafe version of images.

Annotations
@Nullable
nimagesback to summary
public static void nimages(long struct, PointerBuffer value)

Unsafe version of images.

nlevel_xback to summary
public static int nlevel_x(long struct)

Unsafe version of level_x.

nlevel_xback to summary
public static void nlevel_x(long struct, int value)

Unsafe version of level_x.

nlevel_yback to summary
public static int nlevel_y(long struct)

Unsafe version of level_y.

nlevel_yback to summary
public static void nlevel_y(long struct, int value)

Unsafe version of level_y.

nnext_levelback to summary
public static EXRImage nnext_level(long struct)

Unsafe version of next_level.

Annotations
@Nullable
nnext_levelback to summary
public static void nnext_level(long struct, EXRImage value)

Unsafe version of next_level.

nnum_channelsback to summary
public static int nnum_channels(long struct)

Unsafe version of num_channels.

nnum_channelsback to summary
public static void nnum_channels(long struct, int value)

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

nnum_tilesback to summary
public static int nnum_tiles(long struct)

Unsafe version of num_tiles.

nnum_tilesback to summary
public static void nnum_tiles(long struct, int value)

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

ntilesback to summary
public static EXRTile.Buffer ntiles(long struct)

Unsafe version of tiles.

Annotations
@Nullable
ntilesback to summary
public static void ntiles(long struct, EXRTile.Buffer value)

Unsafe version of tiles.

num_channelsback to summary
public int num_channels()
Returns:int

the value of the num_channels field.

num_channelsback to summary
public EXRImage num_channels(int value)

Sets the specified value to the num_channels field.

num_tilesback to summary
public int num_tiles()
Returns:int

the value of the num_tiles field.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

nwidthback to summary
public static void nwidth(long struct, int value)

Unsafe version of width.

setback to summary
public EXRImage set(EXRTile.Buffer tiles, EXRImage next_level, int level_x, int level_y, PointerBuffer images, int width, int height, int num_channels)

Initializes this struct with the specified values.

setback to summary
public EXRImage set(EXRImage src)

Copies the specified struct data to this struct.

Parameters
src:EXRImage

the source struct

Returns:EXRImage

this struct

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
tilesback to summary
public EXRTile.Buffer tiles()

tiled pixel data. The application must reconstruct image from tiles manually. NULL if scanline format.

Annotations
@Nullable
@NativeType:EXRTile *
tilesback to summary
public EXRImage tiles(EXRTile.Buffer value)

Sets the address of the specified EXRTile.Buffer to the tiles field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

widthback to summary
public int width()
Returns:int

the value of the width field.

widthback to summary
public EXRImage width(int value)

Sets the specified value to the width field.

org.lwjgl.util.tinyexr back to summary

public Class EXRImage.Buffer

extends StructBuffer<EXRImage, EXRImage.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of EXRImage structs.

Field Summary

Modifier and TypeField and Description
private static final EXRImage

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new EXRImage.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected EXRImage
public int

Returns:

the value of the height field.
height
()

public EXRImage.Buffer
height(int value)

Sets the specified value to the height field.

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the EXRImage#images field.
images
()

public EXRImage.Buffer
images(PointerBuffer value)

Sets the address of the specified PointerBuffer to the EXRImage#images field.

public int

Returns:

the value of the EXRImage#level_x field.
level_x
()

public EXRImage.Buffer
level_x(int value)

Sets the specified value to the EXRImage#level_x field.

public int

Returns:

the value of the EXRImage#level_y field.
level_y
()

public EXRImage.Buffer
level_y(int value)

Sets the specified value to the EXRImage#level_y field.

public EXRImage

Returns:

a EXRImage view of the struct pointed to by the EXRImage#next_level field.
next_level
()

public EXRImage.Buffer
next_level(EXRImage value)

Sets the address of the specified EXRImage to the EXRImage#next_level field.

public int

Returns:

the value of the num_channels field.
num_channels
()

public EXRImage.Buffer
num_channels(int value)

Sets the specified value to the num_channels field.

public int

Returns:

the value of the num_tiles field.
num_tiles
()

protected EXRImage.Buffer
public EXRTile.Buffer

Returns:

a EXRTile.Buffer view of the struct array pointed to by the EXRImage#tiles field.
tiles
()

public EXRImage.Buffer
tiles(EXRTile.Buffer value)

Sets the address of the specified EXRTile.Buffer to the EXRImage#tiles field.

public int

Returns:

the value of the width field.
width
()

public EXRImage.Buffer
width(int value)

Sets the specified value to the width field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final EXRImage ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new EXRImage.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by EXRImage#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected EXRImage getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
heightback to summary
public int height()
Returns:int

the value of the height field.

heightback to summary
public EXRImage.Buffer height(int value)

Sets the specified value to the height field.

imagesback to summary
public PointerBuffer images()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the EXRImage#images field.

Annotations
@Nullable
@NativeType:unsigned char **
imagesback to summary
public EXRImage.Buffer images(PointerBuffer value)

Sets the address of the specified PointerBuffer to the EXRImage#images field.

level_xback to summary
public int level_x()
Returns:int

the value of the EXRImage#level_x field.

level_xback to summary
public EXRImage.Buffer level_x(int value)

Sets the specified value to the EXRImage#level_x field.

level_yback to summary
public int level_y()
Returns:int

the value of the EXRImage#level_y field.

level_yback to summary
public EXRImage.Buffer level_y(int value)

Sets the specified value to the EXRImage#level_y field.

next_levelback to summary
public EXRImage next_level()
Returns:EXRImage

a EXRImage view of the struct pointed to by the EXRImage#next_level field.

Annotations
@Nullable
@NativeType:struct _EXRImage *
next_levelback to summary
public EXRImage.Buffer next_level(EXRImage value)

Sets the address of the specified EXRImage to the EXRImage#next_level field.

num_channelsback to summary
public int num_channels()
Returns:int

the value of the num_channels field.

num_channelsback to summary
public EXRImage.Buffer num_channels(int value)

Sets the specified value to the num_channels field.

num_tilesback to summary
public int num_tiles()
Returns:int

the value of the num_tiles field.

selfback to summary
protected EXRImage.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
tilesback to summary
public EXRTile.Buffer tiles()
Returns:EXRTile.Buffer

a EXRTile.Buffer view of the struct array pointed to by the EXRImage#tiles field.

Annotations
@Nullable
@NativeType:EXRTile *
tilesback to summary
public EXRImage.Buffer tiles(EXRTile.Buffer value)

Sets the address of the specified EXRTile.Buffer to the EXRImage#tiles field.

widthback to summary
public int width()
Returns:int

the value of the width field.

widthback to summary
public EXRImage.Buffer width(int value)

Sets the specified value to the width field.