Top Description Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXResolution

extends Struct<BGFXResolution>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct bgfx_resolution_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Backbuffer resolution and reset parameters.

Layout


struct bgfx_resolution_t {
    bgfx_texture_format_t format;
    uint32_t width;
    uint32_t height;
    uint32_t reset;
    uint8_t numBackBuffers;
    uint8_t maxFrameLatency;
    uint8_t debugTextScale;
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEBUGTEXTSCALE

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
MAXFRAMELATENCY

The struct member offsets.

public static final int
NUMBACKBUFFERS

The struct member offsets.

public static final int
RESET

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

public
BGFXResolution(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static BGFXResolution
calloc()

Returns a new BGFXResolution instance allocated with memCalloc.

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

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

public static BGFXResolution
callocStack()

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

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

Returns a new BGFXResolution instance allocated with BufferUtils.

public static BGFXResolution
create(long address)

Returns a new BGFXResolution instance for the specified memory address.

public static BGFXResolution
createSafe(long address)

Like create, but returns null if address is NULL.

public byte
debugTextScale()

scale factor for debug text

public BGFXResolution
debugTextScale(byte value)

Sets the specified value to the debugTextScale field.

public int
format()

backbuffer format

public BGFXResolution
format(int value)

Sets the specified value to the format field.

public int
height()

backbuffer height

public BGFXResolution
height(int value)

Sets the specified value to the height field.

public static BGFXResolution
malloc()

Returns a new BGFXResolution instance allocated with memAlloc.

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

Returns a new BGFXResolution instance allocated on the specified MemoryStack.

public static BGFXResolution
mallocStack()

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

Deprecated
Deprecated for removal in 3.4.0.
public byte
maxFrameLatency()

maximum frame latency

public BGFXResolution
maxFrameLatency(byte value)

Sets the specified value to the maxFrameLatency field.

public static byte
ndebugTextScale(long struct)

Unsafe version of debugTextScale.

public static void
ndebugTextScale(long struct, byte value)

Unsafe version of debugTextScale.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static byte
nmaxFrameLatency(long struct)

Unsafe version of maxFrameLatency.

public static void
nmaxFrameLatency(long struct, byte value)

Unsafe version of maxFrameLatency.

public static byte
nnumBackBuffers(long struct)

Unsafe version of numBackBuffers.

public static void
nnumBackBuffers(long struct, byte value)

Unsafe version of numBackBuffers.

public static int
nreset(long struct)

Unsafe version of reset.

public static void
nreset(long struct, int value)

Unsafe version of reset.

public byte
numBackBuffers()

number of back buffers

public BGFXResolution
numBackBuffers(byte value)

Sets the specified value to the numBackBuffers field.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public int
reset()

reset parameters

public BGFXResolution
reset(int value)

Sets the specified value to the reset field.

public BGFXResolution
set(int format, int width, int height, int reset, byte numBackBuffers, byte maxFrameLatency, byte debugTextScale)

Initializes this struct with the specified values.

public BGFXResolution

Returns:

this struct
set(BGFXResolution
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 int
width()

backbuffer width

public BGFXResolution
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.

DEBUGTEXTSCALEback to summary
public static final int DEBUGTEXTSCALE

The struct member offsets.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

MAXFRAMELATENCYback to summary
public static final int MAXFRAMELATENCY

The struct member offsets.

NUMBACKBUFFERSback to summary
public static final int NUMBACKBUFFERS

The struct member offsets.

RESETback to summary
public static final int RESET

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

BGFXResolutionback to summary
protected BGFXResolution(long address, ByteBuffer container)
BGFXResolutionback to summary
public BGFXResolution(ByteBuffer container)

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

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

callocback to summary
public static BGFXResolution calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static BGFXResolution callocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
createback to summary
protected BGFXResolution 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 BGFXResolution create()

Returns a new BGFXResolution instance allocated with BufferUtils.

createback to summary
public static BGFXResolution create(long address)

Returns a new BGFXResolution instance for the specified memory address.

createSafeback to summary
public static BGFXResolution createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
debugTextScaleback to summary
public byte debugTextScale()

scale factor for debug text

Annotations
@NativeType:uint8_t
debugTextScaleback to summary
public BGFXResolution debugTextScale(byte value)

Sets the specified value to the debugTextScale field.

formatback to summary
public int format()

backbuffer format

Annotations
@NativeType:bgfx_texture_format_t
formatback to summary
public BGFXResolution format(int value)

Sets the specified value to the format field.

heightback to summary
public int height()

backbuffer height

Annotations
@NativeType:uint32_t
heightback to summary
public BGFXResolution height(int value)

Sets the specified value to the height field.

mallocback to summary
public static BGFXResolution malloc()

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

mallocback to summary
public static BGFXResolution malloc(MemoryStack stack)

Returns a new BGFXResolution instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static BGFXResolution mallocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
maxFrameLatencyback to summary
public byte maxFrameLatency()

maximum frame latency

Annotations
@NativeType:uint8_t
maxFrameLatencyback to summary
public BGFXResolution maxFrameLatency(byte value)

Sets the specified value to the maxFrameLatency field.

ndebugTextScaleback to summary
public static byte ndebugTextScale(long struct)

Unsafe version of debugTextScale.

ndebugTextScaleback to summary
public static void ndebugTextScale(long struct, byte value)

Unsafe version of debugTextScale.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nformatback to summary
public static void nformat(long struct, int value)

Unsafe version of format.

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.

nmaxFrameLatencyback to summary
public static byte nmaxFrameLatency(long struct)

Unsafe version of maxFrameLatency.

nmaxFrameLatencyback to summary
public static void nmaxFrameLatency(long struct, byte value)

Unsafe version of maxFrameLatency.

nnumBackBuffersback to summary
public static byte nnumBackBuffers(long struct)

Unsafe version of numBackBuffers.

nnumBackBuffersback to summary
public static void nnumBackBuffers(long struct, byte value)

Unsafe version of numBackBuffers.

nresetback to summary
public static int nreset(long struct)

Unsafe version of reset.

nresetback to summary
public static void nreset(long struct, int value)

Unsafe version of reset.

numBackBuffersback to summary
public byte numBackBuffers()

number of back buffers

Annotations
@NativeType:uint8_t
numBackBuffersback to summary
public BGFXResolution numBackBuffers(byte value)

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

resetback to summary
public int reset()

reset parameters

Annotations
@NativeType:uint32_t
resetback to summary
public BGFXResolution reset(int value)

Sets the specified value to the reset field.

setback to summary
public BGFXResolution set(int format, int width, int height, int reset, byte numBackBuffers, byte maxFrameLatency, byte debugTextScale)

Initializes this struct with the specified values.

setback to summary
public BGFXResolution set(BGFXResolution src)

Copies the specified struct data to this struct.

Parameters
src:BGFXResolution

the source struct

Returns:BGFXResolution

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
widthback to summary
public int width()

backbuffer width

Annotations
@NativeType:uint32_t
widthback to summary
public BGFXResolution width(int value)

Sets the specified value to the width field.