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

public Class EXRAttribute

extends Struct<EXRAttribute>
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 EXRAttribute {
    char name[256];
    char type[256];
    unsigned char * value;
    int size;
    char[4];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
EXRAttribute.Buffer

An array of EXRAttribute structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NAME

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
VALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
EXRAttribute(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static EXRAttribute
calloc()

Returns a new EXRAttribute instance allocated with memCalloc.

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

Returns a new EXRAttribute.Buffer instance allocated with memCalloc.

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

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

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

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

public static EXRAttribute
callocStack()

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

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

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

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

Returns a new EXRAttribute instance allocated with BufferUtils.

public static EXRAttribute
create(long address)

Returns a new EXRAttribute instance for the specified memory address.

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

Returns a new EXRAttribute.Buffer instance allocated with BufferUtils.

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

Create a EXRAttribute.Buffer instance at the specified memory.

public static EXRAttribute
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static EXRAttribute
malloc()

Returns a new EXRAttribute instance allocated with memAlloc.

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

Returns a new EXRAttribute.Buffer instance allocated with memAlloc.

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

Returns a new EXRAttribute instance allocated on the specified MemoryStack.

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

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

public static EXRAttribute
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer

Returns:

a ByteBuffer view of the name field.
name
()

public EXRAttribute
name(ByteBuffer value)

Copies the specified encoded string to the name field.

public String

Returns:

the null-terminated string stored in the name field.
nameString
()

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

Unsafe version of size.

public static void
nsize(long struct, int value)

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

public static ByteBuffer
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, ByteBuffer value)

Unsafe version of type.

public static String
ntypeString(long struct)

Unsafe version of typeString.

public static ByteBuffer
nvalue(long struct)

Unsafe version of value.

public static void
nvalue(long struct, ByteBuffer value)

Unsafe version of value.

public EXRAttribute
set(ByteBuffer name, ByteBuffer type, ByteBuffer value)

Initializes this struct with the specified values.

public EXRAttribute

Returns:

this struct
set
(EXRAttribute
the source struct
src
)

Copies the specified struct data to this struct.

public int

Returns:

the value of the size field.
size
()

public int
sizeof()

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

Returns sizeof(struct).
public ByteBuffer

Returns:

a ByteBuffer view of the type field.
type
()

public EXRAttribute
type(ByteBuffer value)

Copies the specified encoded string to the type field.

public String

Returns:

the null-terminated string stored in the type field.
typeString
()

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

Validates pointer members that should not be NULL.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the value field.
value
()

public EXRAttribute
value(ByteBuffer value)

Sets the address of the specified ByteBuffer to the value 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.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

VALUEback to summary
public static final int VALUE

The struct member offsets.

Constructor Detail

EXRAttributeback to summary
protected EXRAttribute(long address, ByteBuffer container)
EXRAttributeback to summary
public EXRAttribute(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static EXRAttribute calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static EXRAttribute.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 EXRAttribute 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 EXRAttribute create()

Returns a new EXRAttribute instance allocated with BufferUtils.

createback to summary
public static EXRAttribute create(long address)

Returns a new EXRAttribute instance for the specified memory address.

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

Returns a new EXRAttribute.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a EXRAttribute.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static EXRAttribute createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static EXRAttribute malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static EXRAttribute malloc(MemoryStack stack)

Returns a new EXRAttribute instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the name field.

Annotations
@NativeType:char[256]
nameback to summary
public EXRAttribute name(ByteBuffer value)

Copies the specified encoded string to the name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the name field.

Annotations
@NativeType:char[256]
nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameback to summary
public static void nname(long struct, ByteBuffer value)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

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

ntypeback to summary
public static ByteBuffer ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, ByteBuffer value)

Unsafe version of type.

ntypeStringback to summary
public static String ntypeString(long struct)

Unsafe version of typeString.

nvalueback to summary
public static ByteBuffer nvalue(long struct)

Unsafe version of value.

Annotations
@Nullable
nvalueback to summary
public static void nvalue(long struct, ByteBuffer value)

Unsafe version of value.

setback to summary
public EXRAttribute set(ByteBuffer name, ByteBuffer type, ByteBuffer value)

Initializes this struct with the specified values.

setback to summary
public EXRAttribute set(EXRAttribute src)

Copies the specified struct data to this struct.

Parameters
src:EXRAttribute

the source struct

Returns:EXRAttribute

this struct

sizeback to summary
public int size()
Returns:int

the value of the size field.

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
typeback to summary
public ByteBuffer type()
Returns:ByteBuffer

a ByteBuffer view of the type field.

Annotations
@NativeType:char[256]
typeback to summary
public EXRAttribute type(ByteBuffer value)

Copies the specified encoded string to the type field.

typeStringback to summary
public String typeString()
Returns:String

the null-terminated string stored in the type field.

Annotations
@NativeType:char[256]
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

valueback to summary
public ByteBuffer value()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the value field.

Annotations
@Nullable
@NativeType:unsigned char *
valueback to summary
public EXRAttribute value(ByteBuffer value)

Sets the address of the specified ByteBuffer to the value field.

org.lwjgl.util.tinyexr back to summary

public Class EXRAttribute.Buffer

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

An array of EXRAttribute structs.

Field Summary

Modifier and TypeField and Description
private static final EXRAttribute

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new EXRAttribute.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 EXRAttribute
public ByteBuffer

Returns:

a ByteBuffer view of the name field.
name
()

public EXRAttribute.Buffer
name(ByteBuffer value)

Copies the specified encoded string to the name field.

public String

Returns:

the null-terminated string stored in the name field.
nameString
()

protected EXRAttribute.Buffer
public int

Returns:

the value of the size field.
size
()

public ByteBuffer

Returns:

a ByteBuffer view of the type field.
type
()

public EXRAttribute.Buffer
type(ByteBuffer value)

Copies the specified encoded string to the type field.

public String

Returns:

the null-terminated string stored in the type field.
typeString
()

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the value field.
value
()

public EXRAttribute.Buffer
value(ByteBuffer value)

Sets the address of the specified ByteBuffer to the value field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final EXRAttribute ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new EXRAttribute.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 EXRAttribute#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 EXRAttribute getElementFactory()

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

Annotations
@Override
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the name field.

Annotations
@NativeType:char[256]
nameback to summary
public EXRAttribute.Buffer name(ByteBuffer value)

Copies the specified encoded string to the name field.

nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the name field.

Annotations
@NativeType:char[256]
selfback to summary
protected EXRAttribute.Buffer self()

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

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the size field.

typeback to summary
public ByteBuffer type()
Returns:ByteBuffer

a ByteBuffer view of the type field.

Annotations
@NativeType:char[256]
typeback to summary
public EXRAttribute.Buffer type(ByteBuffer value)

Copies the specified encoded string to the type field.

typeStringback to summary
public String typeString()
Returns:String

the null-terminated string stored in the type field.

Annotations
@NativeType:char[256]
valueback to summary
public ByteBuffer value()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the value field.

Annotations
@Nullable
@NativeType:unsigned char *
valueback to summary
public EXRAttribute.Buffer value(ByteBuffer value)

Sets the address of the specified ByteBuffer to the value field.