Package org.lwjgl.bgfx

Class BGFXTextureInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<BGFXTextureInfo>

org.lwjgl.bgfx.BGFXTextureInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class BGFXTextureInfo
extends org.lwjgl.system.Struct<BGFXTextureInfo>
implements org.lwjgl.system.NativeResource

Texture info.

Layout

 struct bgfx_texture_info_t {
     bgfx_texture_format_t format();
     uint32_t storageSize();
     uint16_t width();
     uint16_t height();
     uint16_t depth();
     uint16_t numLayers();
     uint8_t numMips();
     uint8_t bitsPerPixel();
     bool cubeMap();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BGFXTextureInfo.Buffer	An array of BGFXTextureInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BITSPERPIXEL	The struct member offsets.
static final int	CUBEMAP	The struct member offsets.
static final int	DEPTH	The struct member offsets.
static final int	FORMAT	The struct member offsets.
static final int	HEIGHT	The struct member offsets.
static final int	NUMLAYERS	The struct member offsets.
static final int	NUMMIPS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STORAGESIZE	The struct member offsets.
static final 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	Description
BGFXTextureInfo(ByteBuffer container)	Creates a BGFXTextureInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
byte	bitsPerPixel()	format bits per pixel
static BGFXTextureInfo	calloc()	Returns a new BGFXTextureInfo instance allocated with memCalloc.
static BGFXTextureInfo.Buffer	calloc(int capacity)	Returns a new BGFXTextureInfo.Buffer instance allocated with memCalloc.
static BGFXTextureInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new BGFXTextureInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXTextureInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new BGFXTextureInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static BGFXTextureInfo	callocStack()	Deprecated.
static BGFXTextureInfo.Buffer	callocStack(int capacity)	Deprecated.
static BGFXTextureInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static BGFXTextureInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static BGFXTextureInfo	create()	Returns a new BGFXTextureInfo instance allocated with BufferUtils.
static BGFXTextureInfo.Buffer	create(int capacity)	Returns a new BGFXTextureInfo.Buffer instance allocated with BufferUtils.
static BGFXTextureInfo	create(long address)	Returns a new BGFXTextureInfo instance for the specified memory address.
static BGFXTextureInfo.Buffer	create(long address, int capacity)	Create a BGFXTextureInfo.Buffer instance at the specified memory.
static @Nullable BGFXTextureInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable BGFXTextureInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	cubeMap()	texture is cubemap
short	depth()	texture depth
int	format()	texture format.
short	height()	texture height
static BGFXTextureInfo	malloc()	Returns a new BGFXTextureInfo instance allocated with memAlloc.
static BGFXTextureInfo.Buffer	malloc(int capacity)	Returns a new BGFXTextureInfo.Buffer instance allocated with memAlloc.
static BGFXTextureInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new BGFXTextureInfo.Buffer instance allocated on the specified MemoryStack.
static BGFXTextureInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new BGFXTextureInfo instance allocated on the specified MemoryStack.
static BGFXTextureInfo	mallocStack()	Deprecated.
static BGFXTextureInfo.Buffer	mallocStack(int capacity)	Deprecated.
static BGFXTextureInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static BGFXTextureInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static byte	nbitsPerPixel(long struct)	Unsafe version of bitsPerPixel().
static boolean	ncubeMap(long struct)	Unsafe version of cubeMap().
static short	ndepth(long struct)	Unsafe version of depth().
static int	nformat(long struct)	Unsafe version of format().
static short	nheight(long struct)	Unsafe version of height().
static short	nnumLayers(long struct)	Unsafe version of numLayers().
static byte	nnumMips(long struct)	Unsafe version of numMips().
static int	nstorageSize(long struct)	Unsafe version of storageSize().
short	numLayers()	number of layers in texture array
byte	numMips()	number of MIP maps
static short	nwidth(long struct)	Unsafe version of width().
int	sizeof()
int	storageSize()	total amount of bytes required to store texture
short	width()	texture width

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

FORMAT

public static final int FORMAT

The struct member offsets.

STORAGESIZE

public static final int STORAGESIZE

The struct member offsets.

WIDTH

public static final int WIDTH

The struct member offsets.

HEIGHT

public static final int HEIGHT

The struct member offsets.

DEPTH

public static final int DEPTH

The struct member offsets.

NUMLAYERS

public static final int NUMLAYERS

The struct member offsets.

NUMMIPS

public static final int NUMMIPS

The struct member offsets.

BITSPERPIXEL

public static final int BITSPERPIXEL

The struct member offsets.

CUBEMAP

public static final int CUBEMAP

The struct member offsets.

Constructor Details

BGFXTextureInfo

public BGFXTextureInfo(ByteBuffer container)

Creates a BGFXTextureInfo 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<BGFXTextureInfo>

format

public int format()

texture format. One of:

TEXTURE_FORMAT_BC1	TEXTURE_FORMAT_BC2	TEXTURE_FORMAT_BC3	TEXTURE_FORMAT_BC4
TEXTURE_FORMAT_BC5	TEXTURE_FORMAT_BC6H	TEXTURE_FORMAT_BC7	TEXTURE_FORMAT_ETC1
TEXTURE_FORMAT_ETC2	TEXTURE_FORMAT_ETC2A	TEXTURE_FORMAT_ETC2A1	TEXTURE_FORMAT_PTC12
TEXTURE_FORMAT_PTC14	TEXTURE_FORMAT_PTC12A	TEXTURE_FORMAT_PTC14A	TEXTURE_FORMAT_PTC22
TEXTURE_FORMAT_PTC24	TEXTURE_FORMAT_ATC	TEXTURE_FORMAT_ATCE	TEXTURE_FORMAT_ATCI
TEXTURE_FORMAT_ASTC4x4	TEXTURE_FORMAT_ASTC5X4	TEXTURE_FORMAT_ASTC5x5	TEXTURE_FORMAT_ASTC6X5
TEXTURE_FORMAT_ASTC6x6	TEXTURE_FORMAT_ASTC8x5	TEXTURE_FORMAT_ASTC8x6	TEXTURE_FORMAT_ASTC8X8
TEXTURE_FORMAT_ASTC10x5	TEXTURE_FORMAT_ASTC10X6	TEXTURE_FORMAT_ASTC10X8	TEXTURE_FORMAT_ASTC10X10
TEXTURE_FORMAT_ASTC12X10	TEXTURE_FORMAT_ASTC12X12	TEXTURE_FORMAT_UNKNOWN	TEXTURE_FORMAT_R1
TEXTURE_FORMAT_A8	TEXTURE_FORMAT_R8	TEXTURE_FORMAT_R8I	TEXTURE_FORMAT_R8U
TEXTURE_FORMAT_R8S	TEXTURE_FORMAT_R16	TEXTURE_FORMAT_R16I	TEXTURE_FORMAT_R16U
TEXTURE_FORMAT_R16F	TEXTURE_FORMAT_R16S	TEXTURE_FORMAT_R32I	TEXTURE_FORMAT_R32U
TEXTURE_FORMAT_R32F	TEXTURE_FORMAT_RG8	TEXTURE_FORMAT_RG8I	TEXTURE_FORMAT_RG8U
TEXTURE_FORMAT_RG8S	TEXTURE_FORMAT_RG16	TEXTURE_FORMAT_RG16I	TEXTURE_FORMAT_RG16U
TEXTURE_FORMAT_RG16F	TEXTURE_FORMAT_RG16S	TEXTURE_FORMAT_RG32I	TEXTURE_FORMAT_RG32U
TEXTURE_FORMAT_RG32F	TEXTURE_FORMAT_RGB8	TEXTURE_FORMAT_RGB8I	TEXTURE_FORMAT_RGB8U
TEXTURE_FORMAT_RGB8S	TEXTURE_FORMAT_RGB9E5F	TEXTURE_FORMAT_BGRA8	TEXTURE_FORMAT_RGBA8
TEXTURE_FORMAT_RGBA8I	TEXTURE_FORMAT_RGBA8U	TEXTURE_FORMAT_RGBA8S	TEXTURE_FORMAT_RGBA16
TEXTURE_FORMAT_RGBA16I	TEXTURE_FORMAT_RGBA16U	TEXTURE_FORMAT_RGBA16F	TEXTURE_FORMAT_RGBA16S
TEXTURE_FORMAT_RGBA32I	TEXTURE_FORMAT_RGBA32U	TEXTURE_FORMAT_RGBA32F	TEXTURE_FORMAT_B5G6R5
TEXTURE_FORMAT_R5G6B5	TEXTURE_FORMAT_BGRA4	TEXTURE_FORMAT_RGBA4	TEXTURE_FORMAT_BGR5A1
TEXTURE_FORMAT_RGB5A1	TEXTURE_FORMAT_RGB10A2	TEXTURE_FORMAT_RG11B10F	TEXTURE_FORMAT_UNKNOWN_DEPTH
TEXTURE_FORMAT_D16	TEXTURE_FORMAT_D24	TEXTURE_FORMAT_D24S8	TEXTURE_FORMAT_D32
TEXTURE_FORMAT_D16F	TEXTURE_FORMAT_D24F	TEXTURE_FORMAT_D32F	TEXTURE_FORMAT_D0S8

storageSize

public int storageSize()

total amount of bytes required to store texture

width

public short width()

texture width

height

public short height()

texture height

depth

public short depth()

texture depth

numLayers

public short numLayers()

number of layers in texture array

numMips

public byte numMips()

number of MIP maps

bitsPerPixel

public byte bitsPerPixel()

format bits per pixel

cubeMap

public boolean cubeMap()

texture is cubemap

malloc

public static BGFXTextureInfo malloc()

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

calloc

public static BGFXTextureInfo calloc()

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

create

public static BGFXTextureInfo create()

Returns a new BGFXTextureInfo instance allocated with BufferUtils.

create

public static BGFXTextureInfo create(long address)

Returns a new BGFXTextureInfo instance for the specified memory address.

createSafe

public static @Nullable BGFXTextureInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static BGFXTextureInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static BGFXTextureInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static BGFXTextureInfo.Buffer create(int capacity)

Returns a new BGFXTextureInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static BGFXTextureInfo.Buffer create(long address,
 int capacity)

Create a BGFXTextureInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable BGFXTextureInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static BGFXTextureInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static BGFXTextureInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTextureInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTextureInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTextureInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTextureInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static BGFXTextureInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static BGFXTextureInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static BGFXTextureInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new BGFXTextureInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static BGFXTextureInfo calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static BGFXTextureInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static BGFXTextureInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nformat

public static int nformat(long struct)

Unsafe version of format().

nstorageSize

public static int nstorageSize(long struct)

Unsafe version of storageSize().

nwidth

public static short nwidth(long struct)

Unsafe version of width().

nheight

public static short nheight(long struct)

Unsafe version of height().

ndepth

public static short ndepth(long struct)

Unsafe version of depth().

nnumLayers

public static short nnumLayers(long struct)

Unsafe version of numLayers().

nnumMips

public static byte nnumMips(long struct)

Unsafe version of numMips().

nbitsPerPixel

public static byte nbitsPerPixel(long struct)

Unsafe version of bitsPerPixel().

ncubeMap

public static boolean ncubeMap(long struct)

Unsafe version of cubeMap().