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

public Class TinyEXR

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Native bindings to the Tiny OpenEXR image library.

tinyexr is a small, single header-only library to load and save OpenEXR(.exr) images.

Field Summary

Modifier and TypeField and Description
public static final int
TINYEXR_COMPRESSIONTYPE_NONE

Compression types.

public static final int
TINYEXR_COMPRESSIONTYPE_PIZ

Compression types.

public static final int
TINYEXR_COMPRESSIONTYPE_RLE

Compression types.

public static final int
TINYEXR_COMPRESSIONTYPE_ZFP

Compression types.

public static final int
TINYEXR_COMPRESSIONTYPE_ZIP

Compression types.

public static final int
TINYEXR_COMPRESSIONTYPE_ZIPS

Compression types.

public static final int
TINYEXR_ERROR_CANT_OPEN_FILE

Error codes.

public static final int
TINYEXR_ERROR_CANT_WRITE_FILE

Error codes.

public static final int
TINYEXR_ERROR_DATA_TOO_LARGE

Error codes.

public static final int
TINYEXR_ERROR_INVALID_ARGUMENT

Error codes.

public static final int
TINYEXR_ERROR_INVALID_DATA

Error codes.

public static final int
TINYEXR_ERROR_INVALID_EXR_VERSION

Error codes.

public static final int
TINYEXR_ERROR_INVALID_FILE

Error codes.

public static final int
TINYEXR_ERROR_INVALID_HEADER

Error codes.

public static final int
TINYEXR_ERROR_INVALID_MAGIC_NUMBER

Error codes.

public static final int
TINYEXR_ERROR_INVALID_PARAMETER

Error codes.

public static final int
TINYEXR_ERROR_LAYER_NOT_FOUND

Error codes.

public static final int
TINYEXR_ERROR_SERIALIZATION_FAILED

Error codes.

public static final int
TINYEXR_ERROR_UNSUPPORTED_FEATURE

Error codes.

public static final int
TINYEXR_ERROR_UNSUPPORTED_FORMAT

Error codes.

public static final int
TINYEXR_MAX_CUSTOM_ATTRIBUTES

public static final int
TINYEXR_MAX_HEADER_ATTRIBUTES

public static final int
TINYEXR_PIXELTYPE_FLOAT

Pixel types.

public static final int
TINYEXR_PIXELTYPE_HALF

Pixel types.

public static final int
TINYEXR_PIXELTYPE_UINT

Pixel types.

public static final int
TINYEXR_SUCCESS

Error codes.

public static final int
TINYEXR_TILE_MIPMAP_LEVELS

Tile level types.

public static final int
TINYEXR_TILE_ONE_LEVEL

Tile level types.

public static final int
TINYEXR_TILE_RIPMAP_LEVELS

Tile level types.

public static final int
TINYEXR_TILE_ROUND_DOWN

Tile rounding types.

public static final int
TINYEXR_TILE_ROUND_UP

Tile rounding types.

public static final int
TINYEXR_ZFP_COMPRESSIONTYPE_ACCURACY

ZFP compression types.

public static final int
TINYEXR_ZFP_COMPRESSIONTYPE_PRECISION

ZFP compression types.

public static final int
TINYEXR_ZFP_COMPRESSIONTYPE_RATE

ZFP compression types.

Constructor Summary

AccessConstructor and Description
protected
TinyEXR()

Method Summary

Modifier and TypeMethod and Description
public static int

Returns:

SUCCESS upon success.
EXRLayers(ByteBuffer filename, PointerBuffer
list of layer names. Application must free memory after using this.
layer_names, IntBuffer
the number of layers
num_layers, PointerBuffer
Error string(will be filled when the function returns error code). Free it using FreeEXRErrorMessage after using this value.
err)

Get layer infos from EXR file.

public static int

Returns:

SUCCESS upon success.
EXRLayers(CharSequence filename, PointerBuffer
list of layer names. Application must free memory after using this.
layer_names, IntBuffer
the number of layers
num_layers, PointerBuffer
Error string(will be filled when the function returns error code). Free it using FreeEXRErrorMessage after using this value.
err)

Get layer infos from EXR file.

public static int
EXRNumLevels(EXRImage exr_image)

Returns the number of resolution levels of the image (including the base).

public static void
EXRSetNameAttr(EXRHeader exr_header, ByteBuffer name)

Sets name attribute of EXRHeader struct (it makes a copy).

public static void
EXRSetNameAttr(EXRHeader exr_header, CharSequence name)

Sets name attribute of EXRHeader struct (it makes a copy).

public static void
FreeEXRErrorMessage(ByteBuffer msg)

Frees error message

public static int
FreeEXRHeader(EXRHeader exr_header)

Frees internal data of EXRHeader struct

public static int
FreeEXRImage(EXRImage exr_image)

Frees internal data of EXRImage struct

public static void
InitEXRHeader(EXRHeader exr_header)

Initialize EXRHeader struct.

public static void
InitEXRImage(EXRImage exr_image)

Initialize EXRImage struct.

public static int

Returns:

SUCCESS for EXR image, ERROR_INVALID_HEADER for others
IsEXRFromMemory(ByteBuffer memory)

Checks if given data is a EXR image (by just looking up a header section).

public static int

Returns:

negative value and may set error string in err when there's an error
LoadDeepEXR(DeepImage out_image, ByteBuffer filename, PointerBuffer err)

Loads single-frame OpenEXR deep image.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadDeepEXR(DeepImage out_image, CharSequence filename, PointerBuffer err)

Loads single-frame OpenEXR deep image.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRImageFromFile(EXRImage image, EXRHeader header, ByteBuffer filename, PointerBuffer err)

Loads single-part OpenEXR image from a file.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRImageFromFile(EXRImage image, EXRHeader header, CharSequence filename, PointerBuffer err)

Loads single-part OpenEXR image from a file.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRImageFromMemory(EXRImage image, EXRHeader header, ByteBuffer memory, PointerBuffer err)

Loads single-part OpenEXR image from a memory.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRMultipartImageFromFile(EXRImage.Buffer images, PointerBuffer headers, ByteBuffer filename, PointerBuffer err)

Loads multi-part OpenEXR image from a file.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRMultipartImageFromFile(EXRImage.Buffer images, PointerBuffer headers, CharSequence filename, PointerBuffer err)

Loads multi-part OpenEXR image from a file.

public static int

Returns:

negative value and may set error string in err when there's an error
LoadEXRMultipartImageFromMemory(EXRImage.Buffer images, PointerBuffer headers, ByteBuffer memory, PointerBuffer err)

Loads multi-part OpenEXR image from a memory.

public static int

Returns:

negative value and may set error string in err when there's an error. When the specified layer name is not found in the EXR file, the function will return ERROR_LAYER_NOT_FOUND.
LoadEXRWithLayer(PointerBuffer out_rgba, IntBuffer width, IntBuffer height, ByteBuffer filename, ByteBuffer layer_name, PointerBuffer err)

Loads single-frame OpenEXR image by specifying layer name.

public static int

Returns:

negative value and may set error string in err when there's an error. When the specified layer name is not found in the EXR file, the function will return ERROR_LAYER_NOT_FOUND.
LoadEXRWithLayer(PointerBuffer out_rgba, IntBuffer width, IntBuffer height, CharSequence filename, CharSequence layer_name, PointerBuffer err)

Loads single-frame OpenEXR image by specifying layer name.

public static native int
nEXRLayers(long filename, long layer_names, long num_layers, long err)

Unsafe version of: EXRLayers

public static native int
nEXRNumLevels(long exr_image)

Unsafe version of: EXRNumLevels

public static native void
nEXRSetNameAttr(long exr_header, long name)

Unsafe version of: EXRSetNameAttr

public static native void
nFreeEXRErrorMessage(long msg)

Unsafe version of: FreeEXRErrorMessage

public static native int
nFreeEXRHeader(long exr_header)

Unsafe version of: FreeEXRHeader

public static native int
nFreeEXRImage(long exr_image)

Unsafe version of: FreeEXRImage

public static native void
nInitEXRHeader(long exr_header)

Unsafe version of: InitEXRHeader

public static native void
nInitEXRImage(long exr_image)

Unsafe version of: InitEXRImage

public static native int
nIsEXRFromMemory(long memory, long size)

Unsafe version of: IsEXRFromMemory

public static native int
nLoadDeepEXR(long out_image, long filename, long err)

Unsafe version of: LoadDeepEXR

public static native int
nLoadEXRImageFromFile(long image, long header, long filename, long err)

Unsafe version of: LoadEXRImageFromFile

public static native int
nLoadEXRImageFromMemory(long image, long header, long memory, long size, long err)

Unsafe version of: LoadEXRImageFromMemory

public static native int
nLoadEXRMultipartImageFromFile(long images, long headers, int num_parts, long filename, long err)

Unsafe version of: LoadEXRMultipartImageFromFile

public static native int
nLoadEXRMultipartImageFromMemory(long images, long headers, int num_parts, long memory, long size, long err)

Unsafe version of: LoadEXRMultipartImageFromMemory

public static native int
nLoadEXRWithLayer(long out_rgba, long width, long height, long filename, long layer_name, long err)

Unsafe version of: LoadEXRWithLayer

public static native int
nParseEXRHeaderFromFile(long header, long version, long filename, long err)

Unsafe version of: ParseEXRHeaderFromFile

public static native int
nParseEXRHeaderFromMemory(long header, long version, long memory, long size, long err)

Unsafe version of: ParseEXRHeaderFromMemory

public static native int
nParseEXRMultipartHeaderFromFile(long headers, long num_headers, long version, long filename, long err)

Unsafe version of: ParseEXRMultipartHeaderFromFile

public static native int
nParseEXRMultipartHeaderFromMemory(long headers, long num_headers, long version, long memory, long size, long err)

Unsafe version of: ParseEXRMultipartHeaderFromMemory

public static native int
nParseEXRVersionFromFile(long version, long filename)

Unsafe version of: ParseEXRVersionFromFile

public static native int
nParseEXRVersionFromMemory(long version, long memory, long size)

Unsafe version of: ParseEXRVersionFromMemory

public static native int
nSaveEXRImageToFile(long image, long exr_header, long filename, long err)

Unsafe version of: SaveEXRImageToFile

public static native long
nSaveEXRImageToMemory(long image, long exr_header, long memory, long err)

Unsafe version of: SaveEXRImageToMemory

public static native int
nSaveEXRMultipartImageToFile(long images, long exr_headers, int num_parts, long filename, long err)

Unsafe version of: SaveEXRMultipartImageToFile

public static native long
nSaveEXRMultipartImageToMemory(long images, long exr_headers, int num_parts, long memory, long err)

Unsafe version of: SaveEXRMultipartImageToMemory

public static int
ParseEXRHeaderFromFile(EXRHeader header, EXRVersion version, ByteBuffer filename, PointerBuffer err)

Parse single-part OpenEXR header from a file and initialize EXRHeader.

public static int
ParseEXRHeaderFromFile(EXRHeader header, EXRVersion version, CharSequence filename, PointerBuffer err)

Parse single-part OpenEXR header from a file and initialize EXRHeader.

public static int
ParseEXRHeaderFromMemory(EXRHeader header, EXRVersion version, ByteBuffer memory, PointerBuffer err)

Parse single-part OpenEXR header from a memory and initialize EXRHeader.

public static int
ParseEXRMultipartHeaderFromFile(PointerBuffer headers, IntBuffer num_headers, EXRVersion version, ByteBuffer filename, PointerBuffer err)

Parse multi-part OpenEXR headers from a file and initialize EXRHeader* array.

public static int
ParseEXRMultipartHeaderFromFile(PointerBuffer headers, IntBuffer num_headers, EXRVersion version, CharSequence filename, PointerBuffer err)

Parse multi-part OpenEXR headers from a file and initialize EXRHeader* array.

public static int
ParseEXRMultipartHeaderFromMemory(PointerBuffer headers, IntBuffer num_headers, EXRVersion version, ByteBuffer memory, PointerBuffer err)

Parse multi-part OpenEXR headers from a memory and initialize EXRHeader* array.

public static int
ParseEXRVersionFromFile(EXRVersion version, ByteBuffer filename)

Parse EXR version header of a file.

public static int
ParseEXRVersionFromFile(EXRVersion version, CharSequence filename)

Parse EXR version header of a file.

public static int
ParseEXRVersionFromMemory(EXRVersion version, ByteBuffer memory)

Parse EXR version header from memory-mapped EXR data.

public static int

Returns:

negative value and may set error string in err when there's an error
SaveEXRImageToFile(EXRImage image, EXRHeader exr_header, ByteBuffer filename, PointerBuffer err)

Saves multi-channel, single-frame OpenEXR image to a file.

public static int

Returns:

negative value and may set error string in err when there's an error
SaveEXRImageToFile(EXRImage image, EXRHeader exr_header, CharSequence filename, PointerBuffer err)

Saves multi-channel, single-frame OpenEXR image to a file.

public static long

Returns:

the number of bytes if success or zero and may set error string in err when there's an error
SaveEXRImageToMemory(EXRImage image, EXRHeader exr_header, PointerBuffer memory, PointerBuffer err)

Saves multi-channel, single-frame OpenEXR image to a memory.

public static int

Returns:

negative value and may set error string in err when there's an error.

When there was an error message, Application must free err with FreeEXRErrorMessage.

SaveEXRMultipartImageToFile(EXRImage.Buffer images, PointerBuffer exr_headers, ByteBuffer filename, PointerBuffer err)

Saves multi-channel, multi-frame OpenEXR image to a file.

public static int

Returns:

negative value and may set error string in err when there's an error.

When there was an error message, Application must free err with FreeEXRErrorMessage.

SaveEXRMultipartImageToFile(EXRImage.Buffer images, PointerBuffer exr_headers, CharSequence filename, PointerBuffer err)

Saves multi-channel, multi-frame OpenEXR image to a file.

public static long

Returns:

the number of bytes if success. Return zero and will set error string in err when there's an error.

When there was an error message, Application must free err with FreeEXRErrorMessage.

SaveEXRMultipartImageToMemory(EXRImage.Buffer images, PointerBuffer exr_headers, PointerBuffer memory, PointerBuffer err)

Saves multi-channel, multi-frame OpenEXR image to a memory.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait