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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkFramebufferAttachmentImageInfoKHR
```
public class VkFramebufferAttachmentImageInfo
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 VkRenderPassAttachmentBeginInfo, must be created with parameters that are identical to those specified here.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO
- 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

VkFramebufferAttachmentsCreateInfo

Layout
```
 struct VkFramebufferAttachmentImageInfo {
     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 Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FLAGS HEIGHT LAYERCOUNT PNEXT PVIEWFORMATS`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE USAGE VIEWFORMATCOUNT 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	Description
`VkFramebufferAttachmentImageInfo(java.nio.ByteBuffer container)`	Creates a `VkFramebufferAttachmentImageInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkFramebufferAttachmentImageInfo`	`calloc()`	Returns a new `VkFramebufferAttachmentImageInfo` instance allocated with `memCalloc`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkFramebufferAttachmentImageInfo.Buffer` instance allocated with `memCalloc`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFramebufferAttachmentImageInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfo`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFramebufferAttachmentImageInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFramebufferAttachmentImageInfo`	`create()`	Returns a new `VkFramebufferAttachmentImageInfo` instance allocated with `BufferUtils`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`create(int capacity)`	Returns a new `VkFramebufferAttachmentImageInfo.Buffer` instance allocated with `BufferUtils`.
`static VkFramebufferAttachmentImageInfo`	`create(long address)`	Returns a new `VkFramebufferAttachmentImageInfo` instance for the specified memory address.
`static VkFramebufferAttachmentImageInfo.Buffer`	`create(long address, int capacity)`	Create a `VkFramebufferAttachmentImageInfo.Buffer` instance at the specified memory.
`static VkFramebufferAttachmentImageInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	a bitmask of `VkImageCreateFlagBits`, matching the value of `VkImageCreateInfo::flags` used to create an image that will be used with this framebuffer.
`VkFramebufferAttachmentImageInfo`	`flags(int value)`	Sets the specified value to the `flags()` field.
`int`	`height()`	the height of the image view used for rendering.
`VkFramebufferAttachmentImageInfo`	`height(int value)`	Sets the specified value to the `height()` field.
`int`	`layerCount()`	the number of array layers of the image view used for rendering.
`VkFramebufferAttachmentImageInfo`	`layerCount(int value)`	Sets the specified value to the `layerCount()` field.
`static VkFramebufferAttachmentImageInfo`	`malloc()`	Returns a new `VkFramebufferAttachmentImageInfo` instance allocated with `memAlloc`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkFramebufferAttachmentImageInfo.Buffer` instance allocated with `memAlloc`.
`static VkFramebufferAttachmentImageInfo.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFramebufferAttachmentImageInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkFramebufferAttachmentImageInfo`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkFramebufferAttachmentImageInfo` 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()`	`NULL` or a pointer to a structure extending this structure.
`VkFramebufferAttachmentImageInfo`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`java.nio.IntBuffer`	`pViewFormats()`	a pointer to an array of `VkFormat` values specifying all of the formats which can be used when creating views of the image, matching the value of `VkImageFormatListCreateInfo::pViewFormats` used to create an image used with this framebuffer.
`VkFramebufferAttachmentImageInfo`	`pViewFormats(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pViewFormats()` field.
`VkFramebufferAttachmentImageInfo`	`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.
`VkFramebufferAttachmentImageInfo`	`set(VkFramebufferAttachmentImageInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkFramebufferAttachmentImageInfo`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkFramebufferAttachmentImageInfo`	`sType$Default()`	Sets the `STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO` value to the `sType()` field.
`int`	`usage()`	a bitmask of `VkImageUsageFlagBits`, matching the value of `VkImageCreateInfo::usage` used to create an image used with this framebuffer.
`VkFramebufferAttachmentImageInfo`	`usage(int value)`	Sets the specified value to the `usage()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`int`	`viewFormatCount()`	the number of entries in the `pViewFormats` array, matching the value of `VkImageFormatListCreateInfo::viewFormatCount` used to create an image used with this framebuffer.
`int`	`width()`	the width of the image view used for rendering.
`VkFramebufferAttachmentImageInfo`	`width(int value)`	Sets the specified value to the `width()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, USAGE, WIDTH, HEIGHT, LAYERCOUNT, VIEWFORMATCOUNT, PVIEWFORMATS
    
    The struct member offsets.
- Constructor Detail
  - VkFramebufferAttachmentImageInfo
```
public VkFramebufferAttachmentImageInfo(java.nio.ByteBuffer container)
```
    Creates a VkFramebufferAttachmentImageInfo 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()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - flags
```
public int flags()
```
    a bitmask of VkImageCreateFlagBits, matching the value of VkImageCreateInfo::flags used to create an image that will be used with this framebuffer.
  - usage
```
public int usage()
```
    a bitmask of VkImageUsageFlagBits, matching the value of VkImageCreateInfo::usage used to create an image used with this framebuffer.
  - width
```
public int width()
```
    the width of the image view used for rendering.
  - height
```
public int height()
```
    the height of the image view used for rendering.
  - layerCount
```
public int layerCount()
```
    the number of array layers of the image view used for rendering.
  - viewFormatCount
```
public int viewFormatCount()
```
    the number of entries in the pViewFormats array, matching the value of VkImageFormatListCreateInfo::viewFormatCount used to create an image used with this framebuffer.
  - pViewFormats
```
@Nullable
public java.nio.IntBuffer pViewFormats()
```
    a pointer to an array of VkFormat values specifying all of the formats which can be used when creating views of the image, matching the value of VkImageFormatListCreateInfo::pViewFormats used to create an image used with this framebuffer.
  - sType
```
public VkFramebufferAttachmentImageInfo sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkFramebufferAttachmentImageInfo sType$Default()
```
    Sets the STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO value to the sType() field.
  - pNext
```
public VkFramebufferAttachmentImageInfo pNext(long value)
```
    Sets the specified value to the pNext() field.
  - flags
```
public VkFramebufferAttachmentImageInfo flags(int value)
```
    Sets the specified value to the flags() field.
  - usage
```
public VkFramebufferAttachmentImageInfo usage(int value)
```
    Sets the specified value to the usage() field.
  - width
```
public VkFramebufferAttachmentImageInfo width(int value)
```
    Sets the specified value to the width() field.
  - height
```
public VkFramebufferAttachmentImageInfo height(int value)
```
    Sets the specified value to the height() field.
  - layerCount
```
public VkFramebufferAttachmentImageInfo layerCount(int value)
```
    Sets the specified value to the layerCount() field.
  - pViewFormats
```
public VkFramebufferAttachmentImageInfo pViewFormats(@Nullable
                                                     java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pViewFormats() field.
  - set
```
public VkFramebufferAttachmentImageInfo 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 VkFramebufferAttachmentImageInfo set(VkFramebufferAttachmentImageInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkFramebufferAttachmentImageInfo malloc()
```
    Returns a new VkFramebufferAttachmentImageInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkFramebufferAttachmentImageInfo calloc()
```
    Returns a new VkFramebufferAttachmentImageInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkFramebufferAttachmentImageInfo create()
```
    Returns a new VkFramebufferAttachmentImageInfo instance allocated with BufferUtils.
  - create
```
public static VkFramebufferAttachmentImageInfo create(long address)
```
    Returns a new VkFramebufferAttachmentImageInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkFramebufferAttachmentImageInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkFramebufferAttachmentImageInfo.Buffer malloc(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkFramebufferAttachmentImageInfo.Buffer calloc(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFramebufferAttachmentImageInfo.Buffer create(int capacity)
```
    Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFramebufferAttachmentImageInfo.Buffer create(long address,
                                                             int capacity)
```
    Create a VkFramebufferAttachmentImageInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkFramebufferAttachmentImageInfo.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkFramebufferAttachmentImageInfo malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkFramebufferAttachmentImageInfo calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkFramebufferAttachmentImageInfo.Buffer malloc(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkFramebufferAttachmentImageInfo.Buffer calloc(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFramebufferAttachmentImageInfo.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

Class VkFramebufferAttachmentImageInfo

Description

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, USAGE, WIDTH, HEIGHT, LAYERCOUNT, VIEWFORMATCOUNT, PVIEWFORMATS

Constructor Detail

VkFramebufferAttachmentImageInfo

Method Detail

sizeof

sType

pNext

flags

usage

width

height

layerCount

viewFormatCount

pViewFormats

sType

sType$Default

pNext

flags

usage

width

height

layerCount

pViewFormats

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nusage

nwidth

nheight

nlayerCount

nviewFormatCount

npViewFormats

nsType

npNext

nflags

nusage

nwidth

nheight

nlayerCount

nviewFormatCount

npViewFormats

validate