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

public Class DeepImage

extends Struct<DeepImage>
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 DeepImage {
    char const ** channel_names;
    float *** image;
    int ** offset_table;
    int num_channels;
    int width;
    int height;
    char[4];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DeepImage.Buffer

An array of DeepImage structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CHANNEL_NAMES

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
IMAGE

The struct member offsets.

public static final int
NUM_CHANNELS

The struct member offsets.

public static final int
OFFSET_TABLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

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
DeepImage(long address, ByteBuffer container)

public
DeepImage(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static DeepImage
calloc()

Returns a new DeepImage instance allocated with memCalloc.

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

Returns a new DeepImage.Buffer instance allocated with memCalloc.

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

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

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

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

public static DeepImage
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the channel_names field.
channel_names()

public DeepImage
channel_names(PointerBuffer value)

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

protected DeepImage
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 DeepImage
create()

Returns a new DeepImage instance allocated with BufferUtils.

public static DeepImage
create(long address)

Returns a new DeepImage instance for the specified memory address.

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

Returns a new DeepImage.Buffer instance allocated with BufferUtils.

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

Create a DeepImage.Buffer instance at the specified memory.

public static DeepImage
createSafe(long address)

Like create, but returns null if address is NULL.

public static DeepImage.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 DeepImage
height(int value)

Sets the specified value to the height field.

public PointerBuffer
image()

image[channels][scanlines][samples]

public DeepImage
image(PointerBuffer value)

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

public static DeepImage
malloc()

Returns a new DeepImage instance allocated with memAlloc.

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

Returns a new DeepImage.Buffer instance allocated with memAlloc.

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

Returns a new DeepImage instance allocated on the specified MemoryStack.

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

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

public static DeepImage
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static PointerBuffer
nchannel_names(long struct)

Unsafe version of channel_names.

public static void
nchannel_names(long struct, PointerBuffer value)

Unsafe version of channel_names.

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

Unsafe version of image.

public static void
nimage(long struct, PointerBuffer value)

Unsafe version of 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 PointerBuffer
noffset_table(long struct, int capacity)

Unsafe version of offset_table.

public static void
noffset_table(long struct, PointerBuffer value)

Unsafe version of offset_table.

public int

Returns:

the value of the num_channels field.
num_channels()

public DeepImage
num_channels(int value)

Sets the specified value to the num_channels field.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public PointerBuffer

Returns:

offset_table[scanline][offsets]
offset_table(int
the number of elements in the returned buffer
capacity)

public DeepImage
offset_table(PointerBuffer value)

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

public DeepImage
set(PointerBuffer channel_names, PointerBuffer image, PointerBuffer offset_table, int num_channels, int width, int height)

Initializes this struct with the specified values.

public DeepImage

Returns:

this struct
set(DeepImage
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 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 DeepImage
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.

CHANNEL_NAMESback to summary
public static final int CHANNEL_NAMES

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

NUM_CHANNELSback to summary
public static final int NUM_CHANNELS

The struct member offsets.

OFFSET_TABLEback to summary
public static final int OFFSET_TABLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

DeepImageback to summary
protected DeepImage(long address, ByteBuffer container)
DeepImageback to summary
public DeepImage(ByteBuffer container)

Creates a DeepImage 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 DeepImage calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static DeepImage calloc(MemoryStack stack)

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

Returns a new DeepImage.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 DeepImage callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
channel_namesback to summary
public PointerBuffer channel_names()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the channel_names field.

Annotations
@NativeType:char const **
channel_namesback to summary
public DeepImage channel_names(PointerBuffer value)

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

createback to summary
protected DeepImage 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 DeepImage create()

Returns a new DeepImage instance allocated with BufferUtils.

createback to summary
public static DeepImage create(long address)

Returns a new DeepImage instance for the specified memory address.

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

Returns a new DeepImage.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a DeepImage.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static DeepImage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static DeepImage.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 DeepImage height(int value)

Sets the specified value to the height field.

imageback to summary
public PointerBuffer image()

image[channels][scanlines][samples]

Annotations
@NativeType:float ***
imageback to summary
public DeepImage image(PointerBuffer value)

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

mallocback to summary
public static DeepImage malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static DeepImage malloc(MemoryStack stack)

Returns a new DeepImage instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new DeepImage.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 DeepImage mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nchannel_namesback to summary
public static PointerBuffer nchannel_names(long struct)

Unsafe version of channel_names.

nchannel_namesback to summary
public static void nchannel_names(long struct, PointerBuffer value)

Unsafe version of channel_names.

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.

nimageback to summary
public static PointerBuffer nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, PointerBuffer value)

Unsafe version of image.

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.

noffset_tableback to summary
public static PointerBuffer noffset_table(long struct, int capacity)

Unsafe version of offset_table.

noffset_tableback to summary
public static void noffset_table(long struct, PointerBuffer value)

Unsafe version of offset_table.

num_channelsback to summary
public int num_channels()
Returns:int

the value of the num_channels field.

num_channelsback to summary
public DeepImage num_channels(int value)

Sets the specified value to the num_channels 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.

offset_tableback to summary
public PointerBuffer offset_table(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:PointerBuffer

offset_table[scanline][offsets]

Annotations
@NativeType:int **
offset_tableback to summary
public DeepImage offset_table(PointerBuffer value)

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

setback to summary
public DeepImage set(PointerBuffer channel_names, PointerBuffer image, PointerBuffer offset_table, int num_channels, int width, int height)

Initializes this struct with the specified values.

setback to summary
public DeepImage set(DeepImage src)

Copies the specified struct data to this struct.

Parameters
src:DeepImage

the source struct

Returns:DeepImage

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
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 DeepImage width(int value)

Sets the specified value to the width field.

org.lwjgl.util.tinyexr back to summary

public Class DeepImage.Buffer

extends StructBuffer<DeepImage, DeepImage.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of DeepImage structs.

Field Summary

Modifier and TypeField and Description
private static final DeepImage
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new DeepImage.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
public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the channel_names field.
channel_names()

public DeepImage.Buffer
channel_names(PointerBuffer value)

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

protected DeepImage
getElementFactory()

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

public int

Returns:

the value of the height field.
height()

public DeepImage.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 DeepImage#image field.
image()

public DeepImage.Buffer
image(PointerBuffer value)

Sets the address of the specified PointerBuffer to the DeepImage#image field.

public int

Returns:

the value of the num_channels field.
num_channels()

public DeepImage.Buffer
num_channels(int value)

Sets the specified value to the num_channels field.

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the DeepImage#offset_table field.
offset_table(int
the number of elements in the returned buffer
capacity)

public DeepImage.Buffer
offset_table(PointerBuffer value)

Sets the address of the specified PointerBuffer to the DeepImage#offset_table field.

protected DeepImage.Buffer
self()

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

public int

Returns:

the value of the width field.
width()

public DeepImage.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 DeepImage ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new DeepImage.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 DeepImage#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

channel_namesback to summary
public PointerBuffer channel_names()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the channel_names field.

Annotations
@NativeType:char const **
channel_namesback to summary
public DeepImage.Buffer channel_names(PointerBuffer value)

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

getElementFactoryback to summary
protected DeepImage 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 DeepImage.Buffer height(int value)

Sets the specified value to the height field.

imageback to summary
public PointerBuffer image()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the DeepImage#image field.

Annotations
@NativeType:float ***
imageback to summary
public DeepImage.Buffer image(PointerBuffer value)

Sets the address of the specified PointerBuffer to the DeepImage#image field.

num_channelsback to summary
public int num_channels()
Returns:int

the value of the num_channels field.

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

Sets the specified value to the num_channels field.

offset_tableback to summary
public PointerBuffer offset_table(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the DeepImage#offset_table field.

Annotations
@NativeType:int **
offset_tableback to summary
public DeepImage.Buffer offset_table(PointerBuffer value)

Sets the address of the specified PointerBuffer to the DeepImage#offset_table field.

selfback to summary
protected DeepImage.Buffer self()

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

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the width field.

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

Sets the specified value to the width field.