DeepImage (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.tinyexr.DeepImage

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class DeepImage
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Member documentation

image – image[channels][scanlines][samples]
offset_table – offset_table[scanline][offsets]

Layout


 struct DeepImage {
     char const ** channel_names;
     float *** image;
     int ** offset_table;
     int num_channels;
     int width;
     int height;
     char[4];
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DeepImage.Buffer
An array of DeepImage structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeepImage.Buffer` An array of `DeepImage` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CHANNEL_NAMES` The struct member offsets.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`IMAGE` The struct member offsets.
`static int`	`NUM_CHANNELS` The struct member offsets.
`static int`	`OFFSET_TABLE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`WIDTH` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

DeepImage(java.nio.ByteBuffer container)
Creates a DeepImage instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`DeepImage(java.nio.ByteBuffer container)` Creates a `DeepImage` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DeepImage`	`calloc()` Returns a new `DeepImage` instance allocated with `memCalloc`.
`static DeepImage.Buffer`	`calloc(int capacity)` Returns a new `DeepImage.Buffer` instance allocated with `memCalloc`.
`static DeepImage`	`callocStack()` Returns a new `DeepImage` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static DeepImage.Buffer`	`callocStack(int capacity)` Returns a new `DeepImage.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static DeepImage.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `DeepImage.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static DeepImage`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `DeepImage` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`org.lwjgl.PointerBuffer`	`channel_names()` Returns a `PointerBuffer` view of the data pointed to by the `channel_names` field.
`DeepImage`	`channel_names(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `channel_names` field.
`static DeepImage`	`create()` Returns a new `DeepImage` instance allocated with `BufferUtils`.
`static DeepImage.Buffer`	`create(int capacity)` Returns a new `DeepImage.Buffer` instance allocated with `BufferUtils`.
`static DeepImage`	`create(long address)` Returns a new `DeepImage` instance for the specified memory address.
`static DeepImage.Buffer`	`create(long address, int capacity)` Create a `DeepImage.Buffer` instance at the specified memory.
`static DeepImage`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static DeepImage.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`height()` Returns the value of the `height` field.
`DeepImage`	`height(int value)` Sets the specified value to the `height` field.
`org.lwjgl.PointerBuffer`	`image()` Returns a `PointerBuffer` view of the data pointed to by the `image` field.
`DeepImage`	`image(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `image` field.
`static DeepImage`	`malloc()` Returns a new `DeepImage` instance allocated with `memAlloc`.
`static DeepImage.Buffer`	`malloc(int capacity)` Returns a new `DeepImage.Buffer` instance allocated with `memAlloc`.
`static DeepImage`	`mallocStack()` Returns a new `DeepImage` instance allocated on the thread-local `MemoryStack`.
`static DeepImage.Buffer`	`mallocStack(int capacity)` Returns a new `DeepImage.Buffer` instance allocated on the thread-local `MemoryStack`.
`static DeepImage.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `DeepImage.Buffer` instance allocated on the specified `MemoryStack`.
`static DeepImage`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `DeepImage` instance allocated on the specified `MemoryStack`.
`static org.lwjgl.PointerBuffer`	`nchannel_names(long struct)` Unsafe version of `channel_names`.
`static void`	`nchannel_names(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `channel_names`.
`static int`	`nheight(long struct)` Unsafe version of `height()`.
`static void`	`nheight(long struct, int value)` Unsafe version of `height`.
`static org.lwjgl.PointerBuffer`	`nimage(long struct)` Unsafe version of `image`.
`static void`	`nimage(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `image`.
`static int`	`nnum_channels(long struct)` Unsafe version of `num_channels()`.
`static void`	`nnum_channels(long struct, int value)` Sets the specified value to the `num_channels` field of the specified `struct`.
`static org.lwjgl.PointerBuffer`	`noffset_table(long struct, int capacity)` Unsafe version of `offset_table`.
`static void`	`noffset_table(long struct, org.lwjgl.PointerBuffer value)` Unsafe version of `offset_table`.
`int`	`num_channels()` Returns the value of the `num_channels` field.
`DeepImage`	`num_channels(int value)` Sets the specified value to the `num_channels` field.
`static int`	`nwidth(long struct)` Unsafe version of `width()`.
`static void`	`nwidth(long struct, int value)` Unsafe version of `width`.
`org.lwjgl.PointerBuffer`	`offset_table(int capacity)` Returns a `PointerBuffer` view of the data pointed to by the `offset_table` field.
`DeepImage`	`offset_table(org.lwjgl.PointerBuffer value)` Sets the address of the specified `PointerBuffer` to the `offset_table` field.
`DeepImage`	`set(DeepImage src)` Copies the specified struct data to this struct.
`DeepImage`	`set(org.lwjgl.PointerBuffer channel_names, org.lwjgl.PointerBuffer image, org.lwjgl.PointerBuffer offset_table, int num_channels, int width, int height)` Initializes this struct with the specified values.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.
`int`	`width()` Returns the value of the `width` field.
`DeepImage`	`width(int value)` Sets the specified value to the `width` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - CHANNEL_NAMES
```
public static final int CHANNEL_NAMES
```
    The struct member offsets.
  - IMAGE
```
public static final int IMAGE
```
    The struct member offsets.
  - OFFSET_TABLE
```
public static final int OFFSET_TABLE
```
    The struct member offsets.
  - NUM_CHANNELS
```
public static final int NUM_CHANNELS
```
    The struct member offsets.
  - WIDTH
```
public static final int WIDTH
```
    The struct member offsets.
  - HEIGHT
```
public static final int HEIGHT
```
    The struct member offsets.
- Constructor Detail
  - DeepImage
```
public DeepImage(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - channel_names
```
public org.lwjgl.PointerBuffer channel_names()
```
    Returns a PointerBuffer view of the data pointed to by the channel_names field.
  - image
```
public org.lwjgl.PointerBuffer image()
```
    Returns a PointerBuffer view of the data pointed to by the image field.
  - offset_table
```
public org.lwjgl.PointerBuffer offset_table(int capacity)
```
    Returns a PointerBuffer view of the data pointed to by the offset_table field.
    
    Parameters:
    
    capacity - the number of elements in the returned buffer
  - num_channels
```
public int num_channels()
```
    Returns the value of the num_channels field.
  - width
```
public int width()
```
    Returns the value of the width field.
  - height
```
public int height()
```
    Returns the value of the height field.
  - channel_names
```
public DeepImage channel_names(org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the channel_names field.
  - image
```
public DeepImage image(org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the image field.
  - offset_table
```
public DeepImage offset_table(org.lwjgl.PointerBuffer value)
```
    Sets the address of the specified PointerBuffer to the offset_table field.
  - num_channels
```
public DeepImage num_channels(int value)
```
    Sets the specified value to the num_channels field.
  - width
```
public DeepImage width(int value)
```
    Sets the specified value to the width field.
  - height
```
public DeepImage height(int value)
```
    Sets the specified value to the height field.
  - set
```
public DeepImage set(org.lwjgl.PointerBuffer channel_names,
                     org.lwjgl.PointerBuffer image,
                     org.lwjgl.PointerBuffer offset_table,
                     int num_channels,
                     int width,
                     int height)
```
    Initializes this struct with the specified values.
  - set
```
public DeepImage set(DeepImage src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static DeepImage malloc()
```
    Returns a new DeepImage instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static DeepImage calloc()
```
    Returns a new DeepImage instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static DeepImage create()
```
    Returns a new DeepImage instance allocated with BufferUtils.
  - create
```
public static DeepImage create(long address)
```
    Returns a new DeepImage instance for the specified memory address.
  - createSafe
```
@Nullable
public static DeepImage createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static DeepImage.Buffer malloc(int capacity)
```
    Returns a new DeepImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static DeepImage.Buffer calloc(int capacity)
```
    Returns a new DeepImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static DeepImage.Buffer create(int capacity)
```
    Returns a new DeepImage.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static DeepImage.Buffer create(long address,
                                      int capacity)
```
    Create a DeepImage.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static DeepImage.Buffer createSafe(long address,
                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static DeepImage mallocStack()
```
    Returns a new DeepImage instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static DeepImage callocStack()
```
    Returns a new DeepImage instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static DeepImage mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new DeepImage instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static DeepImage callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new DeepImage instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static DeepImage.Buffer mallocStack(int capacity)
```
    Returns a new DeepImage.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static DeepImage.Buffer callocStack(int capacity)
```
    Returns a new DeepImage.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static DeepImage.Buffer mallocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new DeepImage.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static DeepImage.Buffer callocStack(int capacity,
                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new DeepImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nchannel_names
```
public static org.lwjgl.PointerBuffer nchannel_names(long struct)
```
    Unsafe version of channel_names.
  - nimage
```
public static org.lwjgl.PointerBuffer nimage(long struct)
```
    Unsafe version of image.
  - noffset_table
```
public static org.lwjgl.PointerBuffer noffset_table(long struct,
                                                    int capacity)
```
    Unsafe version of offset_table.
  - nnum_channels
```
public static int nnum_channels(long struct)
```
    Unsafe version of num_channels().
  - nwidth
```
public static int nwidth(long struct)
```
    Unsafe version of width().
  - nheight
```
public static int nheight(long struct)
```
    Unsafe version of height().
  - nchannel_names
```
public static void nchannel_names(long struct,
                                  org.lwjgl.PointerBuffer value)
```
    Unsafe version of channel_names.
  - nimage
```
public static void nimage(long struct,
                          org.lwjgl.PointerBuffer value)
```
    Unsafe version of image.
  - noffset_table
```
public static void noffset_table(long struct,
                                 org.lwjgl.PointerBuffer value)
```
    Unsafe version of offset_table.
  - nnum_channels
```
public static void nnum_channels(long struct,
                                 int value)
```
    Sets the specified value to the num_channels field of the specified struct.
  - nwidth
```
public static void nwidth(long struct,
                          int value)
```
    Unsafe version of width.
  - nheight
```
public static void nheight(long struct,
                           int value)
```
    Unsafe version of height.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class DeepImage

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

CHANNEL_NAMES

IMAGE

OFFSET_TABLE

NUM_CHANNELS

WIDTH

HEIGHT

Constructor Detail

DeepImage

Method Detail

sizeof

channel_names

image

offset_table

num_channels

width

height

channel_names

image

offset_table

num_channels

width

height

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nchannel_names

nimage

noffset_table

nnum_channels

nwidth

nheight

nchannel_names

nimage

noffset_table

nnum_channels

nwidth

nheight

validate

validate