VkRenderPassAttachmentBeginInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkRenderPassAttachmentBeginInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying images to be used as framebuffer attachments.
Valid Usage
- Each element of pAttachments must only specify a single mip level
- Each element of pAttachments must have been created with the identity swizzle
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_RENDER_PASS_ATTACHMENT_BEGIN_INFO_KHR
- If attachmentCount is not 0, pAttachments must be a valid pointer to an array of attachmentCount valid VkImageView handles
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- attachmentCount – the number of attachments.
- pAttachments – a pointer to an array of VkImageView handles, each of which will be used as the corresponding attachment in the render pass instance.
Layout
```
 struct VkRenderPassAttachmentBeginInfoKHR {
     VkStructureType sType;
     void const * pNext;
     uint32_t attachmentCount;
     VkImageView const * pAttachments;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ATTACHMENTCOUNT` The struct member offsets.
`static int`	`PATTACHMENTS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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
`VkRenderPassAttachmentBeginInfoKHR(java.nio.ByteBuffer container)` Creates a `VkRenderPassAttachmentBeginInfoKHR` 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`	`attachmentCount()` Returns the value of the `attachmentCount` field.
`static VkRenderPassAttachmentBeginInfoKHR`	`calloc()` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated with `memCalloc`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkRenderPassAttachmentBeginInfoKHR`	`callocStack()` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassAttachmentBeginInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassAttachmentBeginInfoKHR`	`create()` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated with `BufferUtils`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkRenderPassAttachmentBeginInfoKHR`	`create(long address)` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance for the specified memory address.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance at the specified memory.
`static VkRenderPassAttachmentBeginInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkRenderPassAttachmentBeginInfoKHR`	`malloc()` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated with `memAlloc`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkRenderPassAttachmentBeginInfoKHR`	`mallocStack()` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkRenderPassAttachmentBeginInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkRenderPassAttachmentBeginInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkRenderPassAttachmentBeginInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkRenderPassAttachmentBeginInfoKHR` instance allocated on the specified `MemoryStack`.
`static int`	`nattachmentCount(long struct)` Unsafe version of `attachmentCount()`.
`static void`	`nattachmentCount(long struct, int value)` Sets the specified value to the `attachmentCount` field of the specified `struct`.
`static java.nio.LongBuffer`	`npAttachments(long struct)` Unsafe version of `pAttachments`.
`static void`	`npAttachments(long struct, java.nio.LongBuffer value)` Unsafe version of `pAttachments`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.LongBuffer`	`pAttachments()` Returns a `LongBuffer` view of the data pointed to by the `pAttachments` field.
`VkRenderPassAttachmentBeginInfoKHR`	`pAttachments(java.nio.LongBuffer value)` Sets the address of the specified `LongBuffer` to the `pAttachments` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkRenderPassAttachmentBeginInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkRenderPassAttachmentBeginInfoKHR`	`set(int sType, long pNext, java.nio.LongBuffer pAttachments)` Initializes this struct with the specified values.
`VkRenderPassAttachmentBeginInfoKHR`	`set(VkRenderPassAttachmentBeginInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkRenderPassAttachmentBeginInfoKHR`	`sType(int value)` Sets the specified value to the `sType` 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.

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.
  - ATTACHMENTCOUNT
```
public static final int ATTACHMENTCOUNT
```
    The struct member offsets.
  - PATTACHMENTS
```
public static final int PATTACHMENTS
```
    The struct member offsets.
- Constructor Detail
  - VkRenderPassAttachmentBeginInfoKHR
```
public VkRenderPassAttachmentBeginInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkRenderPassAttachmentBeginInfoKHR 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.
  - attachmentCount
```
public int attachmentCount()
```
    Returns the value of the attachmentCount field.
  - pAttachments
```
@Nullable
public java.nio.LongBuffer pAttachments()
```
    Returns a LongBuffer view of the data pointed to by the pAttachments field.
  - sType
```
public VkRenderPassAttachmentBeginInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkRenderPassAttachmentBeginInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - pAttachments
```
public VkRenderPassAttachmentBeginInfoKHR pAttachments(@Nullable
                                                       java.nio.LongBuffer value)
```
    Sets the address of the specified LongBuffer to the pAttachments field.
  - set
```
public VkRenderPassAttachmentBeginInfoKHR set(int sType,
                                              long pNext,
                                              @Nullable
                                              java.nio.LongBuffer pAttachments)
```
    Initializes this struct with the specified values.
  - set
```
public VkRenderPassAttachmentBeginInfoKHR set(VkRenderPassAttachmentBeginInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkRenderPassAttachmentBeginInfoKHR malloc()
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkRenderPassAttachmentBeginInfoKHR calloc()
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkRenderPassAttachmentBeginInfoKHR create()
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkRenderPassAttachmentBeginInfoKHR create(long address)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkRenderPassAttachmentBeginInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(int capacity)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer create(long address,
                                                               int capacity)
```
    Create a VkRenderPassAttachmentBeginInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkRenderPassAttachmentBeginInfoKHR.Buffer createSafe(long address,
                                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkRenderPassAttachmentBeginInfoKHR mallocStack()
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkRenderPassAttachmentBeginInfoKHR callocStack()
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkRenderPassAttachmentBeginInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkRenderPassAttachmentBeginInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer mallocStack(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRenderPassAttachmentBeginInfoKHR.Buffer callocStack(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRenderPassAttachmentBeginInfoKHR.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().
  - nattachmentCount
```
public static int nattachmentCount(long struct)
```
    Unsafe version of attachmentCount().
  - npAttachments
```
@Nullable
public static java.nio.LongBuffer npAttachments(long struct)
```
    Unsafe version of pAttachments.
  - 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.
  - nattachmentCount
```
public static void nattachmentCount(long struct,
                                    int value)
```
    Sets the specified value to the attachmentCount field of the specified struct.
  - npAttachments
```
public static void npAttachments(long struct,
                                 @Nullable
                                 java.nio.LongBuffer value)
```
    Unsafe version of pAttachments.
  - 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 VkRenderPassAttachmentBeginInfoKHR

Valid Usage

Valid Usage (Implicit)

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

ATTACHMENTCOUNT

PATTACHMENTS

Constructor Detail

VkRenderPassAttachmentBeginInfoKHR

Method Detail

sizeof

sType

pNext

attachmentCount

pAttachments

sType

pNext

pAttachments

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nattachmentCount

npAttachments

nsType

npNext

nattachmentCount

npAttachments

validate

validate