Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXViewStats

extends Struct<BGFXViewStats>
Class Inheritance
Annotations
@NativeType:struct bgfx_view_stats_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
View stats.

Layout


struct bgfx_view_stats_t {
    char name[256];
    bgfx_view_id_t view;
    int64_t cpuTimeBegin;
    int64_t cpuTimeEnd;
    int64_t gpuTimeBegin;
    int64_t gpuTimeEnd;
    uint32_t gpuFrameNum;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
BGFXViewStats.Buffer

An array of BGFXViewStats 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
GPUFRAMENUM

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
NAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VIEW

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
BGFXViewStats(long address, ByteBuffer container)

public
BGFXViewStats(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
cpuTimeBegin()

CPU (submit) begin time

public long
cpuTimeEnd()

CPU (submit) end time

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

Returns a new BGFXViewStats instance for the specified memory address.

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

Create a BGFXViewStats.Buffer instance at the specified memory.

public static BGFXViewStats
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
gpuFrameNum()

frame which generated gpuTimeBegin, gpuTimeEnd

public long
gpuTimeBegin()

GPU begin time

public long
gpuTimeEnd()

GPU end time

public ByteBuffer
name()

view name

public String
nameString()

view name

public static long
ncpuTimeBegin(long struct)

Unsafe version of cpuTimeBegin.

public static long
ncpuTimeEnd(long struct)

Unsafe version of cpuTimeEnd.

public static int
ngpuFrameNum(long struct)

Unsafe version of gpuFrameNum.

public static long
ngpuTimeBegin(long struct)

Unsafe version of gpuTimeBegin.

public static long
ngpuTimeEnd(long struct)

Unsafe version of gpuTimeEnd.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static short
nview(long struct)

Unsafe version of view.

public int
sizeof()

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

Returns sizeof(struct).
public short
view()

view id

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.

CPUTIMEBEGINback to summary
public static final int CPUTIMEBEGIN

The struct member offsets.

CPUTIMEENDback to summary
public static final int CPUTIMEEND

The struct member offsets.

GPUFRAMENUMback to summary
public static final int GPUFRAMENUM

The struct member offsets.

GPUTIMEBEGINback to summary
public static final int GPUTIMEBEGIN

The struct member offsets.

GPUTIMEENDback to summary
public static final int GPUTIMEEND

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VIEWback to summary
public static final int VIEW

The struct member offsets.

Constructor Detail

BGFXViewStatsback to summary
protected BGFXViewStats(long address, ByteBuffer container)
BGFXViewStatsback to summary
public BGFXViewStats(ByteBuffer container)

Creates a BGFXViewStats 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

cpuTimeBeginback to summary
public long cpuTimeBegin()

CPU (submit) begin time

Annotations
@NativeType:int64_t
cpuTimeEndback to summary
public long cpuTimeEnd()

CPU (submit) end time

Annotations
@NativeType:int64_t
createback to summary
protected BGFXViewStats 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 BGFXViewStats create(long address)

Returns a new BGFXViewStats instance for the specified memory address.

createback to summary
public static BGFXViewStats.Buffer create(long address, int capacity)

Create a BGFXViewStats.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static BGFXViewStats createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static BGFXViewStats.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
gpuFrameNumback to summary
public int gpuFrameNum()

frame which generated gpuTimeBegin, gpuTimeEnd

Annotations
@NativeType:uint32_t
gpuTimeBeginback to summary
public long gpuTimeBegin()

GPU begin time

Annotations
@NativeType:int64_t
gpuTimeEndback to summary
public long gpuTimeEnd()

GPU end time

Annotations
@NativeType:int64_t
nameback to summary
public ByteBuffer name()

view name

Annotations
@NativeType:char[256]
nameStringback to summary
public String nameString()

view name

Annotations
@NativeType:char[256]
ncpuTimeBeginback to summary
public static long ncpuTimeBegin(long struct)

Unsafe version of cpuTimeBegin.

ncpuTimeEndback to summary
public static long ncpuTimeEnd(long struct)

Unsafe version of cpuTimeEnd.

ngpuFrameNumback to summary
public static int ngpuFrameNum(long struct)

Unsafe version of gpuFrameNum.

ngpuTimeBeginback to summary
public static long ngpuTimeBegin(long struct)

Unsafe version of gpuTimeBegin.

ngpuTimeEndback to summary
public static long ngpuTimeEnd(long struct)

Unsafe version of gpuTimeEnd.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nviewback to summary
public static short nview(long struct)

Unsafe version of view.

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
viewback to summary
public short view()

view id

Annotations
@NativeType:bgfx_view_id_t
org.lwjgl.bgfx back to summary

public Class BGFXViewStats.Buffer

extends StructBuffer<BGFXViewStats, BGFXViewStats.Buffer>
Class Inheritance
An array of BGFXViewStats structs.

Field Summary

Modifier and TypeField and Description
private static final BGFXViewStats
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new BGFXViewStats.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the BGFXViewStats#cpuTimeBegin field.
cpuTimeBegin()

public long

Returns:

the value of the BGFXViewStats#cpuTimeEnd field.
cpuTimeEnd()

protected BGFXViewStats
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the BGFXViewStats#gpuFrameNum field.
gpuFrameNum()

public long

Returns:

the value of the BGFXViewStats#gpuTimeBegin field.
gpuTimeBegin()

public long

Returns:

the value of the BGFXViewStats#gpuTimeEnd field.
gpuTimeEnd()

public ByteBuffer

Returns:

a ByteBuffer view of the BGFXViewStats#name field.
name()

public String

Returns:

the null-terminated string stored in the BGFXViewStats#name field.
nameString()

protected BGFXViewStats.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public short

Returns:

the value of the BGFXViewStats#view field.
view()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final BGFXViewStats ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new BGFXViewStats.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by BGFXViewStats#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

cpuTimeBeginback to summary
public long cpuTimeBegin()
Returns:long

the value of the BGFXViewStats#cpuTimeBegin field.

Annotations
@NativeType:int64_t
cpuTimeEndback to summary
public long cpuTimeEnd()
Returns:long

the value of the BGFXViewStats#cpuTimeEnd field.

Annotations
@NativeType:int64_t
getElementFactoryback to summary
protected BGFXViewStats getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
gpuFrameNumback to summary
public int gpuFrameNum()
Returns:int

the value of the BGFXViewStats#gpuFrameNum field.

Annotations
@NativeType:uint32_t
gpuTimeBeginback to summary
public long gpuTimeBegin()
Returns:long

the value of the BGFXViewStats#gpuTimeBegin field.

Annotations
@NativeType:int64_t
gpuTimeEndback to summary
public long gpuTimeEnd()
Returns:long

the value of the BGFXViewStats#gpuTimeEnd field.

Annotations
@NativeType:int64_t
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the BGFXViewStats#name field.

Annotations
@NativeType:char[256]
nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the BGFXViewStats#name field.

Annotations
@NativeType:char[256]
selfback to summary
protected BGFXViewStats.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
viewback to summary
public short view()
Returns:short

the value of the BGFXViewStats#view field.

Annotations
@NativeType:bgfx_view_id_t