BGFXAttachment (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class BGFXAttachment
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Frame buffer texture attachment info.
Member documentation
- access – attachment access
- handle – render target texture handle
- mip – mip level
- layer – cubemap side or depth layer/slice
- resolve – resolve flags. One of:
  RESOLVE_NONE RESOLVE_AUTO_GEN_MIPS
Layout
```
 struct bgfx_attachment_t {
     bgfx_access_t access;
     bgfx_texture_handle_t handle;
     uint16_t mip;
     uint16_t layer;
     uint8_t resolve;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BGFXAttachment.Buffer
An array of BGFXAttachment structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`BGFXAttachment.Buffer` An array of `BGFXAttachment` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESS` The struct member offsets.
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`HANDLE` The struct member offsets.
`static int`	`LAYER` The struct member offsets.
`static int`	`MIP` The struct member offsets.
`static int`	`RESOLVE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`BGFXAttachment(java.nio.ByteBuffer container)` Creates a `BGFXAttachment` 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
`int`	`access()` Returns the value of the `access` field.
`BGFXAttachment`	`access(int value)` Sets the specified value to the `access` field.
`static BGFXAttachment`	`calloc()` Returns a new `BGFXAttachment` instance allocated with `memCalloc`.
`static BGFXAttachment.Buffer`	`calloc(int capacity)` Returns a new `BGFXAttachment.Buffer` instance allocated with `memCalloc`.
`static BGFXAttachment`	`callocStack()` Returns a new `BGFXAttachment` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXAttachment.Buffer`	`callocStack(int capacity)` Returns a new `BGFXAttachment.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static BGFXAttachment.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAttachment.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXAttachment`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAttachment` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static BGFXAttachment`	`create()` Returns a new `BGFXAttachment` instance allocated with `BufferUtils`.
`static BGFXAttachment.Buffer`	`create(int capacity)` Returns a new `BGFXAttachment.Buffer` instance allocated with `BufferUtils`.
`static BGFXAttachment`	`create(long address)` Returns a new `BGFXAttachment` instance for the specified memory address.
`static BGFXAttachment.Buffer`	`create(long address, int capacity)` Create a `BGFXAttachment.Buffer` instance at the specified memory.
`static BGFXAttachment`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static BGFXAttachment.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`short`	`handle()` Returns the value of the `handle` field.
`BGFXAttachment`	`handle(short value)` Sets the specified value to the `handle` field.
`short`	`layer()` Returns the value of the `layer` field.
`BGFXAttachment`	`layer(short value)` Sets the specified value to the `layer` field.
`static BGFXAttachment`	`malloc()` Returns a new `BGFXAttachment` instance allocated with `memAlloc`.
`static BGFXAttachment.Buffer`	`malloc(int capacity)` Returns a new `BGFXAttachment.Buffer` instance allocated with `memAlloc`.
`static BGFXAttachment`	`mallocStack()` Returns a new `BGFXAttachment` instance allocated on the thread-local `MemoryStack`.
`static BGFXAttachment.Buffer`	`mallocStack(int capacity)` Returns a new `BGFXAttachment.Buffer` instance allocated on the thread-local `MemoryStack`.
`static BGFXAttachment.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAttachment.Buffer` instance allocated on the specified `MemoryStack`.
`static BGFXAttachment`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `BGFXAttachment` instance allocated on the specified `MemoryStack`.
`short`	`mip()` Returns the value of the `mip` field.
`BGFXAttachment`	`mip(short value)` Sets the specified value to the `mip` field.
`static int`	`naccess(long struct)` Unsafe version of `access()`.
`static void`	`naccess(long struct, int value)` Unsafe version of `access`.
`static short`	`nhandle(long struct)` Unsafe version of `handle()`.
`static void`	`nhandle(long struct, short value)` Unsafe version of `handle`.
`static short`	`nlayer(long struct)` Unsafe version of `layer()`.
`static void`	`nlayer(long struct, short value)` Unsafe version of `layer`.
`static short`	`nmip(long struct)` Unsafe version of `mip()`.
`static void`	`nmip(long struct, short value)` Unsafe version of `mip`.
`static byte`	`nresolve(long struct)` Unsafe version of `resolve()`.
`static void`	`nresolve(long struct, byte value)` Unsafe version of `resolve`.
`byte`	`resolve()` Returns the value of the `resolve` field.
`BGFXAttachment`	`resolve(byte value)` Sets the specified value to the `resolve` field.
`BGFXAttachment`	`set(BGFXAttachment src)` Copies the specified struct data to this struct.
`BGFXAttachment`	`set(int access, short handle, short mip, short layer, byte resolve)` Initializes this struct with the specified values.
`int`	`sizeof()`

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.
  - ACCESS
```
public static final int ACCESS
```
    The struct member offsets.
  - HANDLE
```
public static final int HANDLE
```
    The struct member offsets.
  - MIP
```
public static final int MIP
```
    The struct member offsets.
  - LAYER
```
public static final int LAYER
```
    The struct member offsets.
  - RESOLVE
```
public static final int RESOLVE
```
    The struct member offsets.
- Constructor Detail
  - BGFXAttachment
```
public BGFXAttachment(java.nio.ByteBuffer container)
```
    Creates a BGFXAttachment 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
  - access
```
public int access()
```
    Returns the value of the access field.
  - handle
```
public short handle()
```
    Returns the value of the handle field.
  - mip
```
public short mip()
```
    Returns the value of the mip field.
  - layer
```
public short layer()
```
    Returns the value of the layer field.
  - resolve
```
public byte resolve()
```
    Returns the value of the resolve field.
  - access
```
public BGFXAttachment access(int value)
```
    Sets the specified value to the access field.
  - handle
```
public BGFXAttachment handle(short value)
```
    Sets the specified value to the handle field.
  - mip
```
public BGFXAttachment mip(short value)
```
    Sets the specified value to the mip field.
  - layer
```
public BGFXAttachment layer(short value)
```
    Sets the specified value to the layer field.
  - resolve
```
public BGFXAttachment resolve(byte value)
```
    Sets the specified value to the resolve field.
  - set
```
public BGFXAttachment set(int access,
                          short handle,
                          short mip,
                          short layer,
                          byte resolve)
```
    Initializes this struct with the specified values.
  - set
```
public BGFXAttachment set(BGFXAttachment src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static BGFXAttachment malloc()
```
    Returns a new BGFXAttachment instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static BGFXAttachment calloc()
```
    Returns a new BGFXAttachment instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static BGFXAttachment create()
```
    Returns a new BGFXAttachment instance allocated with BufferUtils.
  - create
```
public static BGFXAttachment create(long address)
```
    Returns a new BGFXAttachment instance for the specified memory address.
  - createSafe
```
@Nullable
public static BGFXAttachment createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static BGFXAttachment.Buffer malloc(int capacity)
```
    Returns a new BGFXAttachment.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static BGFXAttachment.Buffer calloc(int capacity)
```
    Returns a new BGFXAttachment.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXAttachment.Buffer create(int capacity)
```
    Returns a new BGFXAttachment.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static BGFXAttachment.Buffer create(long address,
                                           int capacity)
```
    Create a BGFXAttachment.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static BGFXAttachment.Buffer createSafe(long address,
                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static BGFXAttachment mallocStack()
```
    Returns a new BGFXAttachment instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static BGFXAttachment callocStack()
```
    Returns a new BGFXAttachment instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static BGFXAttachment mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAttachment instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static BGFXAttachment callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAttachment instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static BGFXAttachment.Buffer mallocStack(int capacity)
```
    Returns a new BGFXAttachment.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXAttachment.Buffer callocStack(int capacity)
```
    Returns a new BGFXAttachment.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static BGFXAttachment.Buffer mallocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAttachment.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static BGFXAttachment.Buffer callocStack(int capacity,
                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new BGFXAttachment.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - naccess
```
public static int naccess(long struct)
```
    Unsafe version of access().
  - nhandle
```
public static short nhandle(long struct)
```
    Unsafe version of handle().
  - nmip
```
public static short nmip(long struct)
```
    Unsafe version of mip().
  - nlayer
```
public static short nlayer(long struct)
```
    Unsafe version of layer().
  - nresolve
```
public static byte nresolve(long struct)
```
    Unsafe version of resolve().
  - naccess
```
public static void naccess(long struct,
                           int value)
```
    Unsafe version of access.
  - nhandle
```
public static void nhandle(long struct,
                           short value)
```
    Unsafe version of handle.
  - nmip
```
public static void nmip(long struct,
                        short value)
```
    Unsafe version of mip.
  - nlayer
```
public static void nlayer(long struct,
                          short value)
```
    Unsafe version of layer.
  - nresolve
```
public static void nresolve(long struct,
                            byte value)
```
    Unsafe version of resolve.

Class BGFXAttachment

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

ACCESS

HANDLE

MIP

LAYER

RESOLVE

Constructor Detail

BGFXAttachment

Method Detail

sizeof

access

handle

mip

layer

resolve

access

handle

mip

layer

resolve

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

naccess

nhandle

nmip

nlayer

nresolve

naccess

nhandle

nmip

nlayer

nresolve