Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXStats

extends Struct<BGFXStats>
Class Inheritance
Annotations
@NativeType:struct bgfx_stats_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
Renderer statistics data.

All time values are high-resolution timestamps, while time frequencies define timestamps-per-second for that hardware.

Layout


struct bgfx_stats_t {
    int64_t cpuTimeFrame;
    int64_t cpuTimeBegin;
    int64_t cpuTimeEnd;
    int64_t cpuTimerFreq;
    int64_t gpuTimeBegin;
    int64_t gpuTimeEnd;
    int64_t gpuTimerFreq;
    int64_t waitRender;
    int64_t waitSubmit;
    uint32_t numDraw;
    uint32_t numCompute;
    uint32_t numBlit;
    uint32_t maxGpuLatency;
    uint32_t gpuFrameNum;
    uint16_t numDynamicIndexBuffers;
    uint16_t numDynamicVertexBuffers;
    uint16_t numFrameBuffers;
    uint16_t numIndexBuffers;
    uint16_t numOcclusionQueries;
    uint16_t numPrograms;
    uint16_t numShaders;
    uint16_t numTextures;
    uint16_t numUniforms;
    uint16_t numVertexBuffers;
    uint16_t numVertexLayouts;
    int64_t textureMemoryUsed;
    int64_t rtMemoryUsed;
    int32_t transientVbUsed;
    int32_t transientIbUsed;
    uint32_t numPrims[BGFX_TOPOLOGY_COUNT];
    int64_t gpuMemoryMax;
    int64_t gpuMemoryUsed;
    uint16_t width;
    uint16_t height;
    uint16_t textWidth;
    uint16_t textHeight;
    uint16_t numViews;
    bgfx_view_stats_t * viewStats;
    uint16_t numEncoders;
    bgfx_encoder_stats_t * encoderStats;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
BGFXStats.Buffer

An array of BGFXStats structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CPUTIMEBEGIN

The struct member offsets.

public static final int
CPUTIMEEND

The struct member offsets.

public static final int
CPUTIMEFRAME

The struct member offsets.

public static final int
CPUTIMERFREQ

The struct member offsets.

public static final int
ENCODERSTATS

The struct member offsets.

public static final int
GPUFRAMENUM

The struct member offsets.

public static final int
GPUMEMORYMAX

The struct member offsets.

public static final int
GPUMEMORYUSED

The struct member offsets.

public static final int
GPUTIMEBEGIN

The struct member offsets.

public static final int
GPUTIMEEND

The struct member offsets.

public static final int
GPUTIMERFREQ

The struct member offsets.

public static final int
HEIGHT

The struct member offsets.

public static final int
MAXGPULATENCY

The struct member offsets.

public static final int
NUMBLIT

The struct member offsets.

public static final int
NUMCOMPUTE

The struct member offsets.

public static final int
NUMDRAW

The struct member offsets.

public static final int
NUMDYNAMICINDEXBUFFERS

The struct member offsets.

public static final int
NUMDYNAMICVERTEXBUFFERS

The struct member offsets.

public static final int
NUMENCODERS

The struct member offsets.

public static final int
NUMFRAMEBUFFERS

The struct member offsets.

public static final int
NUMINDEXBUFFERS

The struct member offsets.

public static final int
NUMOCCLUSIONQUERIES

The struct member offsets.

public static final int
NUMPRIMS

The struct member offsets.

public static final int
NUMPROGRAMS

The struct member offsets.

public static final int
NUMSHADERS

The struct member offsets.

public static final int
NUMTEXTURES

The struct member offsets.

public static final int
NUMUNIFORMS

The struct member offsets.

public static final int
NUMVERTEXBUFFERS

The struct member offsets.

public static final int
NUMVERTEXLAYOUTS

The struct member offsets.

public static final int
NUMVIEWS

The struct member offsets.

public static final int
RTMEMORYUSED

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TEXTHEIGHT

The struct member offsets.

public static final int
TEXTUREMEMORYUSED

The struct member offsets.

public static final int
TEXTWIDTH

The struct member offsets.

public static final int
TRANSIENTIBUSED

The struct member offsets.

public static final int
TRANSIENTVBUSED

The struct member offsets.

public static final int
VIEWSTATS

The struct member offsets.

public static final int
WAITRENDER

The struct member offsets.

public static final int
WAITSUBMIT

The struct member offsets.

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

public
BGFXStats(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
cpuTimeBegin()

Render thread CPU submit begin time

public long
cpuTimeEnd()

Render thread CPU submit end time

public long
cpuTimeFrame()

CPU time between two frame calls

public long
cpuTimerFreq()

CPU timer frequency.

protected BGFXStats
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 BGFXStats
create(long address)

Returns a new BGFXStats instance for the specified memory address.

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

Create a BGFXStats.Buffer instance at the specified memory.

public static BGFXStats
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public BGFXEncoderStats.Buffer
encoderStats()

array of encoder stats

public int
gpuFrameNum()

frame which generated gpuTimeBegin, gpuTimeEnd

public long
gpuMemoryMax()

maximum available GPU memory for application

public long
gpuMemoryUsed()

amount of GPU memory used by the application

public long
gpuTimeBegin()

GPU frame begin time

public long
gpuTimeEnd()

GPU frame end time

public long
gpuTimerFreq()

GPU timer frequency

public short
height()

backbuffer height in pixels

public int
maxGpuLatency()

GPU driver latency

public static long
ncpuTimeBegin(long struct)

Unsafe version of cpuTimeBegin.

public static long
ncpuTimeEnd(long struct)

Unsafe version of cpuTimeEnd.

public static long
ncpuTimeFrame(long struct)

Unsafe version of cpuTimeFrame.

public static long
ncpuTimerFreq(long struct)

Unsafe version of cpuTimerFreq.

public static BGFXEncoderStats.Buffer
nencoderStats(long struct)

Unsafe version of encoderStats.

public static int
ngpuFrameNum(long struct)

Unsafe version of gpuFrameNum.

public static long
ngpuMemoryMax(long struct)

Unsafe version of gpuMemoryMax.

public static long
ngpuMemoryUsed(long struct)

Unsafe version of gpuMemoryUsed.

public static long
ngpuTimeBegin(long struct)

Unsafe version of gpuTimeBegin.

public static long
ngpuTimeEnd(long struct)

Unsafe version of gpuTimeEnd.

public static long
ngpuTimerFreq(long struct)

Unsafe version of gpuTimerFreq.

public static short
nheight(long struct)

Unsafe version of height.

public static int
nmaxGpuLatency(long struct)

Unsafe version of maxGpuLatency.

public static int
nnumBlit(long struct)

Unsafe version of numBlit.

public static int
nnumCompute(long struct)

Unsafe version of numCompute.

public static int
nnumDraw(long struct)

Unsafe version of numDraw.

public static short
nnumDynamicIndexBuffers(long struct)

Unsafe version of numDynamicIndexBuffers.

public static short
nnumDynamicVertexBuffers(long struct)

Unsafe version of numDynamicVertexBuffers.

public static short
nnumEncoders(long struct)

Unsafe version of numEncoders.

public static short
nnumFrameBuffers(long struct)

Unsafe version of numFrameBuffers.

public static short
nnumIndexBuffers(long struct)

Unsafe version of numIndexBuffers.

public static short
nnumOcclusionQueries(long struct)

Unsafe version of numOcclusionQueries.

public static IntBuffer
nnumPrims(long struct)

Unsafe version of numPrims.

public static int
nnumPrims(long struct, int index)

Unsafe version of numPrims.

public static short
nnumPrograms(long struct)

Unsafe version of numPrograms.

public static short
nnumShaders(long struct)

Unsafe version of numShaders.

public static short
nnumTextures(long struct)

Unsafe version of numTextures.

public static short
nnumUniforms(long struct)

Unsafe version of numUniforms.

public static short
nnumVertexBuffers(long struct)

Unsafe version of numVertexBuffers.

public static short
nnumVertexLayouts(long struct)

Unsafe version of numVertexLayouts.

public static short
nnumViews(long struct)

Unsafe version of numViews.

public static long
nrtMemoryUsed(long struct)

Unsafe version of rtMemoryUsed.

public static short
ntextHeight(long struct)

Unsafe version of textHeight.

public static long
ntextureMemoryUsed(long struct)

Unsafe version of textureMemoryUsed.

public static short
ntextWidth(long struct)

Unsafe version of textWidth.

public static int
ntransientIbUsed(long struct)

Unsafe version of transientIbUsed.

public static int
ntransientVbUsed(long struct)

Unsafe version of transientVbUsed.

public int
numBlit()

number of blit calls submitted

public int
numCompute()

number of compute calls submitted

public int
numDraw()

number of draw calls submitted

public short
numDynamicIndexBuffers()

number of used dynamic index buffers

public short
numDynamicVertexBuffers()

number of used dynamic vertex buffers

public short
numEncoders()

number of encoders used during frame

public short
numFrameBuffers()

number of used frame buffers

public short
numIndexBuffers()

number of used index buffers

public short
numOcclusionQueries()

number of used occlusion queries

public IntBuffer
numPrims()

number of primitives rendered

public int
numPrims(int index)

number of primitives rendered

public short
numPrograms()

number of used programs

public short
numShaders()

number of used shaders

public short
numTextures()

number of used textures

public short
numUniforms()

number of used uniforms

public short
numVertexBuffers()

number of used vertex buffers

public short
numVertexLayouts()

number of used vertex layouts

public short
numViews()

number of view stats

public static BGFXViewStats.Buffer
nviewStats(long struct)

Unsafe version of viewStats.

public static long
nwaitRender(long struct)

Unsafe version of waitRender.

public static long
nwaitSubmit(long struct)

Unsafe version of waitSubmit.

public static short
nwidth(long struct)

Unsafe version of width.

public long
rtMemoryUsed()

estimate of render target memory used

public int
sizeof()

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

Returns sizeof(struct).
public short
textHeight()

debug text height in characters

public long
textureMemoryUsed()

estimate of texture memory used

public short
textWidth()

debug text width in characters

public int
transientIbUsed()

amount of transient index buffer used

public int
transientVbUsed()

amount of transient vertex buffer used

public BGFXViewStats.Buffer
viewStats()

array of view stats

public long
waitRender()

time spent waiting for render backend thread to finish issuing draw commands to underlying graphics API

public long
waitSubmit()

time spent waiting for submit thread to advance to next frame

public short
width()

backbuffer width in pixels

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate