VkFramebufferAttachmentImageInfoKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkFramebufferAttachmentImageInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkFramebufferAttachmentImageInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of an image that will be used with a framebuffer.
Description

Images that can be used with the framebuffer when beginning a render pass, as specified by VkRenderPassAttachmentBeginInfoKHR, must be created with parameters that are identical to those specified here.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO_KHR
- pNext must be NULL
- flags must be a valid combination of VkImageCreateFlagBits values
- usage must be a valid combination of VkImageUsageFlagBits values
- usage must not be 0
- If viewFormatCount is not 0, pViewFormats must be a valid pointer to an array of viewFormatCount valid VkFormat values
See Also

VkFramebufferAttachmentsCreateInfoKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkImageCreateFlagBits, matching the value of VkImageCreateInfo::flags used to create an image that will be used with this framebuffer.
- usage – a bitmask of VkImageUsageFlagBits, matching the value of VkImageCreateInfo::usage used to create an image used with this framebuffer.
- width – the width of the image view used for rendering.
- height – the height of the image view used for rendering.
- viewFormatCount – the number of entries in the pViewFormats array, matching the value of VkImageFormatListCreateInfoKHR::viewFormatCount used to create an image used with this framebuffer.
- pViewFormats – an array which lists of all formats which can be used when creating views of the image, matching the value of VkImageFormatListCreateInfoKHR::pViewFormats used to create an image used with this framebuffer.
Layout
```
 struct VkFramebufferAttachmentImageInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkImageCreateFlags flags;
     VkImageUsageFlags usage;
     uint32_t width;
     uint32_t height;
     uint32_t layerCount;
     uint32_t viewFormatCount;
     VkFormat const * pViewFormats;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkFramebufferAttachmentImageInfoKHR.Buffer
An array of VkFramebufferAttachmentImageInfoKHR 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`	`VkFramebufferAttachmentImageInfoKHR.Buffer` An array of `VkFramebufferAttachmentImageInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`HEIGHT` The struct member offsets.
`static int`	`LAYERCOUNT` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PVIEWFORMATS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`USAGE` The struct member offsets.
`static int`	`VIEWFORMATCOUNT` The struct member offsets.
`static int`	`WIDTH` 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
`VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)` Creates a `VkFramebufferAttachmentImageInfoKHR` 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
`static VkFramebufferAttachmentImageInfoKHR`	`calloc()` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated with `memCalloc`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkFramebufferAttachmentImageInfoKHR`	`callocStack()` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfoKHR`	`create()` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated with `BufferUtils`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkFramebufferAttachmentImageInfoKHR`	`create(long address)` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance for the specified memory address.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkFramebufferAttachmentImageInfoKHR.Buffer` instance at the specified memory.
`static VkFramebufferAttachmentImageInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkFramebufferAttachmentImageInfoKHR`	`flags(int value)` Sets the specified value to the `flags` field.
`int`	`height()` Returns the value of the `height` field.
`VkFramebufferAttachmentImageInfoKHR`	`height(int value)` Sets the specified value to the `height` field.
`int`	`layerCount()` Returns the value of the `layerCount` field.
`VkFramebufferAttachmentImageInfoKHR`	`layerCount(int value)` Sets the specified value to the `layerCount` field.
`static VkFramebufferAttachmentImageInfoKHR`	`malloc()` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated with `memAlloc`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkFramebufferAttachmentImageInfoKHR`	`mallocStack()` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkFramebufferAttachmentImageInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFramebufferAttachmentImageInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkFramebufferAttachmentImageInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFramebufferAttachmentImageInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static int`	`nheight(long struct)` Unsafe version of `height()`.
`static void`	`nheight(long struct, int value)` Unsafe version of `height`.
`static int`	`nlayerCount(long struct)` Unsafe version of `layerCount()`.
`static void`	`nlayerCount(long struct, int value)` Unsafe version of `layerCount`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static java.nio.IntBuffer`	`npViewFormats(long struct)` Unsafe version of `pViewFormats`.
`static void`	`npViewFormats(long struct, java.nio.IntBuffer value)` Unsafe version of `pViewFormats`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static int`	`nusage(long struct)` Unsafe version of `usage()`.
`static void`	`nusage(long struct, int value)` Unsafe version of `usage`.
`static int`	`nviewFormatCount(long struct)` Unsafe version of `viewFormatCount()`.
`static void`	`nviewFormatCount(long struct, int value)` Sets the specified value to the `viewFormatCount` field of the specified `struct`.
`static int`	`nwidth(long struct)` Unsafe version of `width()`.
`static void`	`nwidth(long struct, int value)` Unsafe version of `width`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkFramebufferAttachmentImageInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`java.nio.IntBuffer`	`pViewFormats()` Returns a `IntBuffer` view of the data pointed to by the `pViewFormats` field.
`VkFramebufferAttachmentImageInfoKHR`	`pViewFormats(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `pViewFormats` field.
`VkFramebufferAttachmentImageInfoKHR`	`set(int sType, long pNext, int flags, int usage, int width, int height, int layerCount, java.nio.IntBuffer pViewFormats)` Initializes this struct with the specified values.
`VkFramebufferAttachmentImageInfoKHR`	`set(VkFramebufferAttachmentImageInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkFramebufferAttachmentImageInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`usage()` Returns the value of the `usage` field.
`VkFramebufferAttachmentImageInfoKHR`	`usage(int value)` Sets the specified value to the `usage` 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.
`int`	`viewFormatCount()` Returns the value of the `viewFormatCount` field.
`int`	`width()` Returns the value of the `width` field.
`VkFramebufferAttachmentImageInfoKHR`	`width(int value)` Sets the specified value to the `width` 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.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - USAGE
```
public static final int USAGE
```
    The struct member offsets.
  - WIDTH
```
public static final int WIDTH
```
    The struct member offsets.
  - HEIGHT
```
public static final int HEIGHT
```
    The struct member offsets.
  - LAYERCOUNT
```
public static final int LAYERCOUNT
```
    The struct member offsets.
  - VIEWFORMATCOUNT
```
public static final int VIEWFORMATCOUNT
```
    The struct member offsets.
  - PVIEWFORMATS
```
public static final int PVIEWFORMATS
```
    The struct member offsets.
- Constructor Detail
  - VkFramebufferAttachmentImageInfoKHR
```
public VkFramebufferAttachmentImageInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkFramebufferAttachmentImageInfoKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - usage
```
public int usage()
```
    Returns the value of the usage field.
  - width
```
public int width()
```
    Returns the value of the width field.
  - height
```
public int height()
```
    Returns the value of the height field.
  - layerCount
```
public int layerCount()
```
    Returns the value of the layerCount field.
  - viewFormatCount
```
public int viewFormatCount()
```
    Returns the value of the viewFormatCount field.
  - pViewFormats
```
@Nullable
public java.nio.IntBuffer pViewFormats()
```
    Returns a IntBuffer view of the data pointed to by the pViewFormats field.
  - sType
```
public VkFramebufferAttachmentImageInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkFramebufferAttachmentImageInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkFramebufferAttachmentImageInfoKHR flags(int value)
```
    Sets the specified value to the flags field.
  - usage
```
public VkFramebufferAttachmentImageInfoKHR usage(int value)
```
    Sets the specified value to the usage field.
  - width
```
public VkFramebufferAttachmentImageInfoKHR width(int value)
```
    Sets the specified value to the width field.
  - height
```
public VkFramebufferAttachmentImageInfoKHR height(int value)
```
    Sets the specified value to the height field.
  - layerCount
```
public VkFramebufferAttachmentImageInfoKHR layerCount(int value)
```
    Sets the specified value to the layerCount field.
  - pViewFormats
```
public VkFramebufferAttachmentImageInfoKHR pViewFormats(@Nullable
                                                        java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pViewFormats field.
  - set
```
public VkFramebufferAttachmentImageInfoKHR set(int sType,
                                               long pNext,
                                               int flags,
                                               int usage,
                                               int width,
                                               int height,
                                               int layerCount,
                                               @Nullable
                                               java.nio.IntBuffer pViewFormats)
```
    Initializes this struct with the specified values.
  - set
```
public VkFramebufferAttachmentImageInfoKHR set(VkFramebufferAttachmentImageInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkFramebufferAttachmentImageInfoKHR malloc()
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkFramebufferAttachmentImageInfoKHR calloc()
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkFramebufferAttachmentImageInfoKHR create()
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkFramebufferAttachmentImageInfoKHR create(long address)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkFramebufferAttachmentImageInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer create(long address,
                                                                int capacity)
```
    Create a VkFramebufferAttachmentImageInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkFramebufferAttachmentImageInfoKHR.Buffer createSafe(long address,
                                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkFramebufferAttachmentImageInfoKHR mallocStack()
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkFramebufferAttachmentImageInfoKHR callocStack()
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkFramebufferAttachmentImageInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkFramebufferAttachmentImageInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer mallocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFramebufferAttachmentImageInfoKHR.Buffer callocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfoKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nusage
```
public static int nusage(long struct)
```
    Unsafe version of usage().
  - nwidth
```
public static int nwidth(long struct)
```
    Unsafe version of width().
  - nheight
```
public static int nheight(long struct)
```
    Unsafe version of height().
  - nlayerCount
```
public static int nlayerCount(long struct)
```
    Unsafe version of layerCount().
  - nviewFormatCount
```
public static int nviewFormatCount(long struct)
```
    Unsafe version of viewFormatCount().
  - npViewFormats
```
@Nullable
public static java.nio.IntBuffer npViewFormats(long struct)
```
    Unsafe version of pViewFormats.
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nusage
```
public static void nusage(long struct,
                          int value)
```
    Unsafe version of usage.
  - nwidth
```
public static void nwidth(long struct,
                          int value)
```
    Unsafe version of width.
  - nheight
```
public static void nheight(long struct,
                           int value)
```
    Unsafe version of height.
  - nlayerCount
```
public static void nlayerCount(long struct,
                               int value)
```
    Unsafe version of layerCount.
  - nviewFormatCount
```
public static void nviewFormatCount(long struct,
                                    int value)
```
    Sets the specified value to the viewFormatCount field of the specified struct.
  - npViewFormats
```
public static void npViewFormats(long struct,
                                 @Nullable
                                 java.nio.IntBuffer value)
```
    Unsafe version of pViewFormats.
  - 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 VkFramebufferAttachmentImageInfoKHR

Description

Valid Usage (Implicit)

See Also

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

STYPE

PNEXT

FLAGS

USAGE

WIDTH

HEIGHT

LAYERCOUNT

VIEWFORMATCOUNT

PVIEWFORMATS

Constructor Detail

VkFramebufferAttachmentImageInfoKHR

Method Detail

sizeof

sType

pNext

flags

usage

width

height

layerCount

viewFormatCount

pViewFormats

sType

pNext

flags

usage

width

height

layerCount

pViewFormats

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nusage

nwidth

nheight

nlayerCount

nviewFormatCount

npViewFormats

nsType

npNext