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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPipelineRenderingCreateInfoKHR
```
public class VkPipelineRenderingCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying attachment formats.
Description

When a pipeline is created without a VkRenderPass, if this structure is present in the pNext chain of VkGraphicsPipelineCreateInfo, it specifies the view mask and format of attachments used for rendering. If this structure is not specified, and the pipeline does not include a VkRenderPass, viewMask and colorAttachmentCount are 0, and depthAttachmentFormat and stencilAttachmentFormat are FORMAT_UNDEFINED. If a graphics pipeline is created with a valid VkRenderPass, parameters of this structure are ignored.

If depthAttachmentFormat, stencilAttachmentFormat, or any element of pColorAttachmentFormats is FORMAT_UNDEFINED, it indicates that the corresponding attachment is unused within the render pass. Valid formats indicate that an attachment can be used - but it is still valid to set the attachment to NULL when beginning rendering.

Valid Usage
- If any element of pColorAttachmentFormats is not FORMAT_UNDEFINED, it must be a format with potential format features that includes either FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV
- If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format that includes a depth aspect
- If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format that includes a stencil aspect
- If depthAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If stencilAttachmentFormat is not FORMAT_UNDEFINED, it must be a format with potential format features that include FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If depthAttachmentFormat is not FORMAT_UNDEFINED and stencilAttachmentFormat is not FORMAT_UNDEFINED, depthAttachmentFormat must equal stencilAttachmentFormat
- If the multiview feature is not enabled, viewMask must be 0
- The index of the most significant bit in viewMask must be less than maxMultiviewViewCount
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO
- If colorAttachmentCount is not 0, pColorAttachmentFormats must be a valid pointer to an array of colorAttachmentCount valid VkFormat values
- depthAttachmentFormat must be a valid VkFormat value
- stencilAttachmentFormat must be a valid VkFormat value
Layout
```
 struct VkPipelineRenderingCreateInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t viewMask();
     uint32_t colorAttachmentCount();
     VkFormat const * pColorAttachmentFormats();
     VkFormat depthAttachmentFormat();
     VkFormat stencilAttachmentFormat();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkPipelineRenderingCreateInfo.Buffer
An array of VkPipelineRenderingCreateInfo 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`	`COLORATTACHMENTCOUNT DEPTHATTACHMENTFORMAT PCOLORATTACHMENTFORMATS PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STENCILATTACHMENTFORMAT STYPE VIEWMASK`	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
`VkPipelineRenderingCreateInfo(java.nio.ByteBuffer container)`	Creates a `VkPipelineRenderingCreateInfo` 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 VkPipelineRenderingCreateInfo`	`calloc()`	Returns a new `VkPipelineRenderingCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineRenderingCreateInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkPipelineRenderingCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineRenderingCreateInfo.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineRenderingCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineRenderingCreateInfo`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineRenderingCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`colorAttachmentCount()`	the number of entries in `pColorAttachmentFormats`
`static VkPipelineRenderingCreateInfo`	`create()`	Returns a new `VkPipelineRenderingCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineRenderingCreateInfo.Buffer`	`create(int capacity)`	Returns a new `VkPipelineRenderingCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineRenderingCreateInfo`	`create(long address)`	Returns a new `VkPipelineRenderingCreateInfo` instance for the specified memory address.
`static VkPipelineRenderingCreateInfo.Buffer`	`create(long address, int capacity)`	Create a `VkPipelineRenderingCreateInfo.Buffer` instance at the specified memory.
`static VkPipelineRenderingCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineRenderingCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`depthAttachmentFormat()`	a `VkFormat` value defining the format of the depth attachment used in this pipeline.
`VkPipelineRenderingCreateInfo`	`depthAttachmentFormat(int value)`	Sets the specified value to the `depthAttachmentFormat()` field.
`static VkPipelineRenderingCreateInfo`	`malloc()`	Returns a new `VkPipelineRenderingCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineRenderingCreateInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkPipelineRenderingCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineRenderingCreateInfo.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineRenderingCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineRenderingCreateInfo`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPipelineRenderingCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`ncolorAttachmentCount(long struct)`	Unsafe version of `colorAttachmentCount()`.
`static void`	`ncolorAttachmentCount(long struct, int value)`	Sets the specified value to the `colorAttachmentCount` field of the specified `struct`.
`static int`	`ndepthAttachmentFormat(long struct)`	Unsafe version of `depthAttachmentFormat()`.
`static void`	`ndepthAttachmentFormat(long struct, int value)`	Unsafe version of `depthAttachmentFormat`.
`static java.nio.IntBuffer`	`npColorAttachmentFormats(long struct)`	Unsafe version of `pColorAttachmentFormats`.
`static void`	`npColorAttachmentFormats(long struct, java.nio.IntBuffer value)`	Unsafe version of `pColorAttachmentFormats`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nstencilAttachmentFormat(long struct)`	Unsafe version of `stencilAttachmentFormat()`.
`static void`	`nstencilAttachmentFormat(long struct, int value)`	Unsafe version of `stencilAttachmentFormat`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`nviewMask(long struct)`	Unsafe version of `viewMask()`.
`static void`	`nviewMask(long struct, int value)`	Unsafe version of `viewMask`.
`java.nio.IntBuffer`	`pColorAttachmentFormats()`	a pointer to an array of `VkFormat` values defining the format of color attachments used in this pipeline.
`VkPipelineRenderingCreateInfo`	`pColorAttachmentFormats(java.nio.IntBuffer value)`	Sets the address of the specified `IntBuffer` to the `pColorAttachmentFormats()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkPipelineRenderingCreateInfo`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkPipelineRenderingCreateInfo`	`set(int sType, long pNext, int viewMask, java.nio.IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat)`	Initializes this struct with the specified values.
`VkPipelineRenderingCreateInfo`	`set(VkPipelineRenderingCreateInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilAttachmentFormat()`	a `VkFormat` value defining the format of the stencil attachment used in this pipeline.
`VkPipelineRenderingCreateInfo`	`stencilAttachmentFormat(int value)`	Sets the specified value to the `stencilAttachmentFormat()` field.
`int`	`sType()`	the type of this structure.
`VkPipelineRenderingCreateInfo`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkPipelineRenderingCreateInfo`	`sType$Default()`	Sets the `STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO` value to the `sType()` field.
`static void`	`validate(long struct)`	Validates pointer members that should not be `NULL`.
`int`	`viewMask()`	the viewMask used for rendering.
`VkPipelineRenderingCreateInfo`	`viewMask(int value)`	Sets the specified value to the `viewMask()` 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, VIEWMASK, COLORATTACHMENTCOUNT, PCOLORATTACHMENTFORMATS, DEPTHATTACHMENTFORMAT, STENCILATTACHMENTFORMAT
    
    The struct member offsets.
- Constructor Detail
  - VkPipelineRenderingCreateInfo
```
public VkPipelineRenderingCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkPipelineRenderingCreateInfo 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.
  - viewMask
```
public int viewMask()
```
    the viewMask used for rendering.
  - colorAttachmentCount
```
public int colorAttachmentCount()
```
    the number of entries in pColorAttachmentFormats
  - pColorAttachmentFormats
```
@Nullable
public java.nio.IntBuffer pColorAttachmentFormats()
```
    a pointer to an array of VkFormat values defining the format of color attachments used in this pipeline.
  - depthAttachmentFormat
```
public int depthAttachmentFormat()
```
    a VkFormat value defining the format of the depth attachment used in this pipeline.
  - stencilAttachmentFormat
```
public int stencilAttachmentFormat()
```
    a VkFormat value defining the format of the stencil attachment used in this pipeline.
  - sType
```
public VkPipelineRenderingCreateInfo sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkPipelineRenderingCreateInfo sType$Default()
```
    Sets the STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO value to the sType() field.
  - pNext
```
public VkPipelineRenderingCreateInfo pNext(long value)
```
    Sets the specified value to the pNext() field.
  - viewMask
```
public VkPipelineRenderingCreateInfo viewMask(int value)
```
    Sets the specified value to the viewMask() field.
  - pColorAttachmentFormats
```
public VkPipelineRenderingCreateInfo pColorAttachmentFormats(@Nullable
                                                             java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pColorAttachmentFormats() field.
  - depthAttachmentFormat
```
public VkPipelineRenderingCreateInfo depthAttachmentFormat(int value)
```
    Sets the specified value to the depthAttachmentFormat() field.
  - stencilAttachmentFormat
```
public VkPipelineRenderingCreateInfo stencilAttachmentFormat(int value)
```
    Sets the specified value to the stencilAttachmentFormat() field.
  - set
```
public VkPipelineRenderingCreateInfo set(int sType,
                                         long pNext,
                                         int viewMask,
                                         @Nullable
                                         java.nio.IntBuffer pColorAttachmentFormats,
                                         int depthAttachmentFormat,
                                         int stencilAttachmentFormat)
```
    Initializes this struct with the specified values.
  - set
```
public VkPipelineRenderingCreateInfo set(VkPipelineRenderingCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineRenderingCreateInfo malloc()
```
    Returns a new VkPipelineRenderingCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineRenderingCreateInfo calloc()
```
    Returns a new VkPipelineRenderingCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineRenderingCreateInfo create()
```
    Returns a new VkPipelineRenderingCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkPipelineRenderingCreateInfo create(long address)
```
    Returns a new VkPipelineRenderingCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPipelineRenderingCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineRenderingCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkPipelineRenderingCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineRenderingCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkPipelineRenderingCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineRenderingCreateInfo.Buffer create(int capacity)
```
    Returns a new VkPipelineRenderingCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineRenderingCreateInfo.Buffer create(long address,
                                                          int capacity)
```
    Create a VkPipelineRenderingCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPipelineRenderingCreateInfo.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPipelineRenderingCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineRenderingCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkPipelineRenderingCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineRenderingCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkPipelineRenderingCreateInfo.Buffer malloc(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineRenderingCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineRenderingCreateInfo.Buffer calloc(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPipelineRenderingCreateInfo.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().
  - nviewMask
```
public static int nviewMask(long struct)
```
    Unsafe version of viewMask().
  - ncolorAttachmentCount
```
public static int ncolorAttachmentCount(long struct)
```
    Unsafe version of colorAttachmentCount().
  - npColorAttachmentFormats
```
@Nullable
public static java.nio.IntBuffer npColorAttachmentFormats(long struct)
```
    Unsafe version of pColorAttachmentFormats.
  - ndepthAttachmentFormat
```
public static int ndepthAttachmentFormat(long struct)
```
    Unsafe version of depthAttachmentFormat().
  - nstencilAttachmentFormat
```
public static int nstencilAttachmentFormat(long struct)
```
    Unsafe version of stencilAttachmentFormat().
  - 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.
  - nviewMask
```
public static void nviewMask(long struct,
                             int value)
```
    Unsafe version of viewMask.
  - ncolorAttachmentCount
```
public static void ncolorAttachmentCount(long struct,
                                         int value)
```
    Sets the specified value to the colorAttachmentCount field of the specified struct.
  - npColorAttachmentFormats
```
public static void npColorAttachmentFormats(long struct,
                                            @Nullable
                                            java.nio.IntBuffer value)
```
    Unsafe version of pColorAttachmentFormats.
  - ndepthAttachmentFormat
```
public static void ndepthAttachmentFormat(long struct,
                                          int value)
```
    Unsafe version of depthAttachmentFormat.
  - nstencilAttachmentFormat
```
public static void nstencilAttachmentFormat(long struct,
                                            int value)
```
    Unsafe version of stencilAttachmentFormat.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate

Class VkPipelineRenderingCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

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, VIEWMASK, COLORATTACHMENTCOUNT, PCOLORATTACHMENTFORMATS, DEPTHATTACHMENTFORMAT, STENCILATTACHMENTFORMAT

Constructor Detail

VkPipelineRenderingCreateInfo

Method Detail

sizeof

sType

pNext

viewMask

colorAttachmentCount

pColorAttachmentFormats

depthAttachmentFormat

stencilAttachmentFormat

sType

sType$Default

pNext

viewMask

pColorAttachmentFormats

depthAttachmentFormat

stencilAttachmentFormat

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nviewMask

ncolorAttachmentCount

npColorAttachmentFormats

ndepthAttachmentFormat

nstencilAttachmentFormat

nsType

npNext

nviewMask

ncolorAttachmentCount

npColorAttachmentFormats

ndepthAttachmentFormat

nstencilAttachmentFormat

validate