Top Description Inners Fields Constructors Methods
org.lwjgl.nanovg

public Class NVGLUFramebufferBGFX

extends Struct<NVGLUFramebufferBGFX>
Class Inheritance
Annotations
@NativeType:struct NVGLUframebuffer
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
A framebuffer object.

Layout


struct NVGLUframebuffer {
    NVGcontext * ctx;
    bgfx_frame_buffer_handle_t handle;
    int image;
    bgfx_view_id_t viewId;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
NVGLUFramebufferBGFX.Buffer

An array of NVGLUFramebufferBGFX structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CTX

The struct member offsets.

public static final int
HANDLE

The struct member offsets.

public static final int
IMAGE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VIEWID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
NVGLUFramebufferBGFX(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
protected NVGLUFramebufferBGFX
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 NVGLUFramebufferBGFX
create(long address)

Returns a new NVGLUFramebufferBGFX instance for the specified memory address.

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

Create a NVGLUFramebufferBGFX.Buffer instance at the specified memory.

public static NVGLUFramebufferBGFX
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the ctx field.
ctx()

public short

Returns:

the value of the handle field.
handle()

public int

Returns:

the value of the image field.
image()

public static long
nctx(long struct)

Unsafe version of ctx.

public static short
nhandle(long struct)

Unsafe version of handle.

public static int
nimage(long struct)

Unsafe version of image.

public static short
nviewId(long struct)

Unsafe version of viewId.

public int
sizeof()

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

Returns sizeof(struct).
public short

Returns:

the value of the viewId field.
viewId()

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.

CTXback to summary
public static final int CTX

The struct member offsets.

HANDLEback to summary
public static final int HANDLE

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VIEWIDback to summary
public static final int VIEWID

The struct member offsets.

Constructor Detail

NVGLUFramebufferBGFXback to summary
protected NVGLUFramebufferBGFX(long address, ByteBuffer container)
NVGLUFramebufferBGFXback to summary
public NVGLUFramebufferBGFX(ByteBuffer container)

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

createback to summary
protected NVGLUFramebufferBGFX 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 NVGLUFramebufferBGFX create(long address)

Returns a new NVGLUFramebufferBGFX instance for the specified memory address.

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

Create a NVGLUFramebufferBGFX.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static NVGLUFramebufferBGFX createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
ctxback to summary
public long ctx()
Returns:long

the value of the ctx field.

Annotations
@NativeType:NVGcontext *
handleback to summary
public short handle()
Returns:short

the value of the handle field.

Annotations
@NativeType:bgfx_frame_buffer_handle_t
imageback to summary
public int image()
Returns:int

the value of the image field.

nctxback to summary
public static long nctx(long struct)

Unsafe version of ctx.

nhandleback to summary
public static short nhandle(long struct)

Unsafe version of handle.

nimageback to summary
public static int nimage(long struct)

Unsafe version of image.

nviewIdback to summary
public static short nviewId(long struct)

Unsafe version of viewId.

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
viewIdback to summary
public short viewId()
Returns:short

the value of the viewId field.

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

public Class NVGLUFramebufferBGFX.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final NVGLUFramebufferBGFX
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new NVGLUFramebufferBGFX.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 ctx field.
ctx()

protected NVGLUFramebufferBGFX
getElementFactory()

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

public short

Returns:

the value of the handle field.
handle()

public int

Returns:

the value of the image field.
image()

protected NVGLUFramebufferBGFX.Buffer
self()

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

public short

Returns:

the value of the viewId field.
viewId()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final NVGLUFramebufferBGFX ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new NVGLUFramebufferBGFX.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 NVGLUFramebufferBGFX#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

ctxback to summary
public long ctx()
Returns:long

the value of the ctx field.

Annotations
@NativeType:NVGcontext *
getElementFactoryback to summary
protected NVGLUFramebufferBGFX getElementFactory()

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

Annotations
@Override
handleback to summary
public short handle()
Returns:short

the value of the handle field.

Annotations
@NativeType:bgfx_frame_buffer_handle_t
imageback to summary
public int image()
Returns:int

the value of the image field.

selfback to summary
protected NVGLUFramebufferBGFX.Buffer self()

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

Annotations
@Override
viewIdback to summary
public short viewId()
Returns:short

the value of the viewId field.

Annotations
@NativeType:bgfx_view_id_t