BGFXInit (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.bgfx.BGFXInit

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class BGFXInit
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Initialization parameters used by init.

Member documentation

type – select rendering backend. When set to RENDERER_TYPE_COUNT a default rendering backend will be selected appropriate to the platform. One of:

`RENDERER_TYPE_NOOP`	`RENDERER_TYPE_DIRECT3D9`	`RENDERER_TYPE_DIRECT3D11`	`RENDERER_TYPE_DIRECT3D12`
`RENDERER_TYPE_GNM`	`RENDERER_TYPE_METAL`	`RENDERER_TYPE_NVN`	`RENDERER_TYPE_OPENGLES`
`RENDERER_TYPE_OPENGL`	`RENDERER_TYPE_VULKAN`	`RENDERER_TYPE_COUNT`

vendorId – vendor PCI id. If set to PCI_ID_NONE it will select the first device. One of:
PCI_ID_NONE PCI_ID_SOFTWARE_RASTERIZER PCI_ID_AMD PCI_ID_INTEL PCI_ID_NVIDIA
deviceId – device id. If set to 0 it will select first device, or device with matching id.
debug – enable device for debugging
profile – enable device for profiling
platformData – platform data
resolution – backbuffer resolution and reset parameters
callback – provide application specific callback interface
allocator – custom allocator. When a custom allocator is not specified, bgfx uses the CRT allocator. Bgfx assumes custom allocator is thread safe.

Layout


 struct bgfx_init_t {
     bgfx_renderer_type_t type;
     uint16_t vendorId;
     uint16_t deviceId;
     bool debug;
     bool profile;
     bgfx_platform_data_t platformData;
     bgfx_resolution_t resolution;
     bgfx_init_limits_t limits;
     bgfx_callback_interface_t * callback;
     bgfx_allocator_interface_t * allocator;
 }

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ALLOCATOR` The struct member offsets.
`static int`	`CALLBACK` The struct member offsets.
`static int`	`DEBUG` The struct member offsets.
`static int`	`DEVICEID` The struct member offsets.
`static int`	`LIMITS` The struct member offsets.
`static int`	`PLATFORMDATA` The struct member offsets.
`static int`	`PROFILE` The struct member offsets.
`static int`	`RESOLUTION` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TYPE` The struct member offsets.
`static int`	`VENDORID` 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 and Description

BGFXInit(java.nio.ByteBuffer container)
Creates a BGFXInit instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`BGFXInit(java.nio.ByteBuffer container)` Creates a `BGFXInit` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BGFXAllocatorInterface`	`allocator()` Returns a `BGFXAllocatorInterface` view of the struct pointed to by the `allocator` field.
`BGFXInit`	`allocator(BGFXAllocatorInterface value)` Sets the address of the specified `BGFXAllocatorInterface` to the `allocator` field.
`BGFXCallbackInterface`	`callback()` Returns a `BGFXCallbackInterface` view of the struct pointed to by the `callback` field.
`BGFXInit`	`callback(BGFXCallbackInterface value)` Sets the address of the specified `BGFXCallbackInterface` to the `callback` field.
`static BGFXInit`	`calloc()` Returns a new `BGFXInit` instance allocated with `memCalloc`.
`static BGFXInit`	`callocStack()` Returns a new `BGFXInit` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXInit`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInit` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXInit`	`create()` Returns a new `BGFXInit` instance allocated with `BufferUtils`.
`static BGFXInit`	`create(long address)` Returns a new `BGFXInit` instance for the specified memory address.
`static BGFXInit`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`boolean`	`debug()` Returns the value of the `debug` field.
`BGFXInit`	`debug(boolean value)` Sets the specified value to the `debug` field.
`short`	`deviceId()` Returns the value of the `deviceId` field.
`BGFXInit`	`deviceId(short value)` Sets the specified value to the `deviceId` field.
`BGFXInitLimits`	`limits()` Returns a `BGFXInitLimits` view of the `limits` field.
`BGFXInit`	`limits(BGFXInitLimits value)` Copies the specified `BGFXInitLimits` to the `limits` field.
`BGFXInit`	`limits(java.util.function.Consumer<BGFXInitLimits> consumer)` Passes the `limits` field to the specified `Consumer`.
`static BGFXInit`	`malloc()` Returns a new `BGFXInit` instance allocated with `memAlloc`.
`static BGFXInit`	`mallocStack()` Returns a new `BGFXInit` instance allocated on the thread-local `MemoryStack`.
`static BGFXInit`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXInit` instance allocated on the specified `MemoryStack`.
`static BGFXAllocatorInterface`	`nallocator(long struct)` Unsafe version of `allocator()`.
`static void`	`nallocator(long struct, BGFXAllocatorInterface value)` Unsafe version of `allocator`.
`static BGFXCallbackInterface`	`ncallback(long struct)` Unsafe version of `callback()`.
`static void`	`ncallback(long struct, BGFXCallbackInterface value)` Unsafe version of `callback`.
`static boolean`	`ndebug(long struct)` Unsafe version of `debug()`.
`static void`	`ndebug(long struct, boolean value)` Unsafe version of `debug`.
`static short`	`ndeviceId(long struct)` Unsafe version of `deviceId()`.
`static void`	`ndeviceId(long struct, short value)` Unsafe version of `deviceId`.
`static BGFXInitLimits`	`nlimits(long struct)` Unsafe version of `limits()`.
`static void`	`nlimits(long struct, BGFXInitLimits value)` Unsafe version of `limits`.
`static BGFXPlatformData`	`nplatformData(long struct)` Unsafe version of `platformData()`.
`static void`	`nplatformData(long struct, BGFXPlatformData value)` Unsafe version of `platformData`.
`static boolean`	`nprofile(long struct)` Unsafe version of `profile()`.
`static void`	`nprofile(long struct, boolean value)` Unsafe version of `profile`.
`static BGFXResolution`	`nresolution(long struct)` Unsafe version of `resolution()`.
`static void`	`nresolution(long struct, BGFXResolution value)` Unsafe version of `resolution`.
`static int`	`ntype(long struct)` Unsafe version of `type()`.
`static void`	`ntype(long struct, int value)` Unsafe version of `type`.
`static short`	`nvendorId(long struct)` Unsafe version of `vendorId()`.
`static void`	`nvendorId(long struct, short value)` Unsafe version of `vendorId`.
`BGFXPlatformData`	`platformData()` Returns a `BGFXPlatformData` view of the `platformData` field.
`BGFXInit`	`platformData(BGFXPlatformData value)` Copies the specified `BGFXPlatformData` to the `platformData` field.
`BGFXInit`	`platformData(java.util.function.Consumer<BGFXPlatformData> consumer)` Passes the `platformData` field to the specified `Consumer`.
`boolean`	`profile()` Returns the value of the `profile` field.
`BGFXInit`	`profile(boolean value)` Sets the specified value to the `profile` field.
`BGFXResolution`	`resolution()` Returns a `BGFXResolution` view of the `resolution` field.
`BGFXInit`	`resolution(BGFXResolution value)` Copies the specified `BGFXResolution` to the `resolution` field.
`BGFXInit`	`resolution(java.util.function.Consumer<BGFXResolution> consumer)` Passes the `resolution` field to the specified `Consumer`.
`BGFXInit`	`set(BGFXInit src)` Copies the specified struct data to this struct.
`BGFXInit`	`set(int type, short vendorId, short deviceId, boolean debug, boolean profile, BGFXPlatformData platformData, BGFXResolution resolution, BGFXInitLimits limits, BGFXCallbackInterface callback, BGFXAllocatorInterface allocator)` Initializes this struct with the specified values.
`int`	`sizeof()`
`int`	`type()` Returns the value of the `type` field.
`BGFXInit`	`type(int value)` Sets the specified value to the `type` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.
`short`	`vendorId()` Returns the value of the `vendorId` field.
`BGFXInit`	`vendorId(short value)` Sets the specified value to the `vendorId` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
- SIZEOF
```
public static final int SIZEOF
```
  The struct size in bytes.
- ALIGNOF
```
public static final int ALIGNOF
```
  The struct alignment in bytes.
- TYPE
```
public static final int TYPE
```
  The struct member offsets.
- VENDORID
```
public static final int VENDORID
```
  The struct member offsets.
- DEVICEID
```
public static final int DEVICEID
```
  The struct member offsets.
- DEBUG
```
public static final int DEBUG
```
  The struct member offsets.
- PROFILE
```
public static final int PROFILE
```
  The struct member offsets.
- PLATFORMDATA
```
public static final int PLATFORMDATA
```
  The struct member offsets.
- RESOLUTION
```
public static final int RESOLUTION
```
  The struct member offsets.
- LIMITS
```
public static final int LIMITS
```
  The struct member offsets.
- CALLBACK
```
public static final int CALLBACK
```
  The struct member offsets.
- ALLOCATOR
```
public static final int ALLOCATOR
```
  The struct member offsets.

Constructor Detail
- BGFXInit
```
public BGFXInit(java.nio.ByteBuffer container)
```
  Creates a BGFXInit 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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

type
```
public int type()
```
Returns the value of the type field.

vendorId
```
public short vendorId()
```
Returns the value of the vendorId field.

deviceId
```
public short deviceId()
```
Returns the value of the deviceId field.

debug
```
public boolean debug()
```
Returns the value of the debug field.

profile
```
public boolean profile()
```
Returns the value of the profile field.

platformData
```
public BGFXPlatformData platformData()
```
Returns a BGFXPlatformData view of the platformData field.

resolution
```
public BGFXResolution resolution()
```
Returns a BGFXResolution view of the resolution field.

limits
```
public BGFXInitLimits limits()
```
Returns a BGFXInitLimits view of the limits field.

callback
```
@Nullable
public BGFXCallbackInterface callback()
```
Returns a BGFXCallbackInterface view of the struct pointed to by the callback field.

allocator
```
@Nullable
public BGFXAllocatorInterface allocator()
```
Returns a BGFXAllocatorInterface view of the struct pointed to by the allocator field.

type
```
public BGFXInit type(int value)
```
Sets the specified value to the type field.

vendorId
```
public BGFXInit vendorId(short value)
```
Sets the specified value to the vendorId field.

deviceId
```
public BGFXInit deviceId(short value)
```
Sets the specified value to the deviceId field.

debug
```
public BGFXInit debug(boolean value)
```
Sets the specified value to the debug field.

profile
```
public BGFXInit profile(boolean value)
```
Sets the specified value to the profile field.

platformData
```
public BGFXInit platformData(BGFXPlatformData value)
```
Copies the specified BGFXPlatformData to the platformData field.

platformData

public BGFXInit platformData(java.util.function.Consumer<BGFXPlatformData> consumer)

Passes the platformData field to the specified Consumer.

resolution
```
public BGFXInit resolution(BGFXResolution value)
```
Copies the specified BGFXResolution to the resolution field.

resolution

public BGFXInit resolution(java.util.function.Consumer<BGFXResolution> consumer)

Passes the resolution field to the specified Consumer.

limits
```
public BGFXInit limits(BGFXInitLimits value)
```
Copies the specified BGFXInitLimits to the limits field.

limits

public BGFXInit limits(java.util.function.Consumer<BGFXInitLimits> consumer)

Passes the limits field to the specified Consumer.

callback

public BGFXInit callback(@Nullable
                         BGFXCallbackInterface value)

Sets the address of the specified BGFXCallbackInterface to the callback field.

allocator

public BGFXInit allocator(@Nullable
                          BGFXAllocatorInterface value)

Sets the address of the specified BGFXAllocatorInterface to the allocator field.

set

public BGFXInit set(int type,
                    short vendorId,
                    short deviceId,
                    boolean debug,
                    boolean profile,
                    BGFXPlatformData platformData,
                    BGFXResolution resolution,
                    BGFXInitLimits limits,
                    @Nullable
                    BGFXCallbackInterface callback,
                    @Nullable
                    BGFXAllocatorInterface allocator)

Initializes this struct with the specified values.

set
```
public BGFXInit set(BGFXInit src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static BGFXInit malloc()
```
Returns a new BGFXInit instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static BGFXInit calloc()
```
Returns a new BGFXInit instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static BGFXInit create()
```
Returns a new BGFXInit instance allocated with BufferUtils.

create
```
public static BGFXInit create(long address)
```
Returns a new BGFXInit instance for the specified memory address.

createSafe

@Nullable
public static BGFXInit createSafe(long address)

Like create, but returns null if address is NULL.

mallocStack
```
public static BGFXInit mallocStack()
```
Returns a new BGFXInit instance allocated on the thread-local MemoryStack.

callocStack
```
public static BGFXInit callocStack()
```
Returns a new BGFXInit instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static BGFXInit mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new BGFXInit instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static BGFXInit callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new BGFXInit instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

ntype
```
public static int ntype(long struct)
```
Unsafe version of type().

nvendorId

public static short nvendorId(long struct)

Unsafe version of vendorId().

ndeviceId

public static short ndeviceId(long struct)

Unsafe version of deviceId().

ndebug

public static boolean ndebug(long struct)

Unsafe version of debug().

nprofile

public static boolean nprofile(long struct)

Unsafe version of profile().

nplatformData

public static BGFXPlatformData nplatformData(long struct)

Unsafe version of platformData().

nresolution

public static BGFXResolution nresolution(long struct)

Unsafe version of resolution().

nlimits

public static BGFXInitLimits nlimits(long struct)

Unsafe version of limits().

ncallback

@Nullable
public static BGFXCallbackInterface ncallback(long struct)

Unsafe version of callback().

nallocator

@Nullable
public static BGFXAllocatorInterface nallocator(long struct)

Unsafe version of allocator().

ntype

public static void ntype(long struct,
                         int value)

Unsafe version of type.

nvendorId

public static void nvendorId(long struct,
                             short value)

Unsafe version of vendorId.

ndeviceId

public static void ndeviceId(long struct,
                             short value)

Unsafe version of deviceId.

ndebug

public static void ndebug(long struct,
                          boolean value)

Unsafe version of debug.

nprofile

public static void nprofile(long struct,
                            boolean value)

Unsafe version of profile.

nplatformData

public static void nplatformData(long struct,
                                 BGFXPlatformData value)

Unsafe version of platformData.

nresolution

public static void nresolution(long struct,
                               BGFXResolution value)

Unsafe version of resolution.

nlimits

public static void nlimits(long struct,
                           BGFXInitLimits value)

Unsafe version of limits.

ncallback

public static void ncallback(long struct,
                             @Nullable
                             BGFXCallbackInterface value)

Unsafe version of callback.

nallocator

public static void nallocator(long struct,
                              @Nullable
                              BGFXAllocatorInterface value)

Unsafe version of allocator.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

validate
```
public static void validate(long array,
                            int count)
```
Calls validate(long) for each struct contained in the specified struct array.

Parameters:

array - the struct array to validate

count - the number of structs in array

Class BGFXInit

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

TYPE

VENDORID

DEVICEID

DEBUG

PROFILE

PLATFORMDATA

RESOLUTION

LIMITS

CALLBACK

ALLOCATOR

Constructor Detail

BGFXInit

Method Detail

sizeof

type

vendorId

deviceId

debug

profile

platformData

resolution

limits

callback

allocator

type

vendorId

deviceId

debug

profile

platformData

platformData

resolution

resolution

limits

limits

callback

allocator

set

set

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

ntype

nvendorId

ndeviceId

ndebug

nprofile

nplatformData

nresolution

nlimits

ncallback

nallocator

ntype

nvendorId

ndeviceId

ndebug

nprofile

nplatformData