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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkRenderPassBeginInfo
extends Struct
implements NativeResource
```
Structure specifying render pass begin info.
Description

renderArea is the render area that is affected by the render pass instance. The effects of attachment load, store and multisample resolve operations are restricted to the pixels whose x and y coordinates fall within the render area on all attachments. The render area extends to all layers of framebuffer. The application must ensure (using scissor if necessary) that all rendering is contained within the render area, otherwise the pixels outside of the render area become undefined and shader side effects may occur for fragments outside the render area. The render area must be contained within the framebuffer dimensions.

When multiview is enabled, the resolve operation at the end of a subpass applies to all views in the view mask.

Note

There may be a performance cost for using a render area smaller than the framebuffer, unless it matches the render area granularity for the render pass.

Valid Usage
- clearValueCount must be greater than the largest attachment index in renderPass that specifies a loadOp (or stencilLoadOp, if the attachment has a depth/stencil format) of ATTACHMENT_LOAD_OP_CLEAR
- If clearValueCount is not 0, pClearValues must be a valid pointer to an array of clearValueCount valid VkClearValue unions
- renderPass must be compatible with the renderPass member of the VkFramebufferCreateInfo structure specified when creating framebuffer.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkDeviceGroupRenderPassBeginInfo or VkRenderPassSampleLocationsBeginInfoEXT
- Each sType member in the pNext chain must be unique
- renderPass must be a valid VkRenderPass handle
- framebuffer must be a valid VkFramebuffer handle
- Both of framebuffer, and renderPass must have been created, allocated, or retrieved from the same VkDevice
See Also

VkClearValue, VkRect2D, CmdBeginRenderPass, CmdBeginRenderPass2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- renderPass – the render pass to begin an instance of.
- framebuffer – the framebuffer containing the attachments that are used with the render pass.
- renderArea – the render area that is affected by the render pass instance, and is described in more detail below.
- clearValueCount – the number of elements in pClearValues.
- pClearValues – an array of VkClearValue structures that contains clear values for each attachment, if the attachment uses a loadOp value of ATTACHMENT_LOAD_OP_CLEAR or if the attachment has a depth/stencil format and uses a stencilLoadOp value of ATTACHMENT_LOAD_OP_CLEAR. The array is indexed by attachment number. Only elements corresponding to cleared attachments are used. Other elements of pClearValues are ignored.
Layout
```
 struct VkRenderPassBeginInfo {
     VkStructureType sType;
     void const * pNext;
     VkRenderPass renderPass;
     VkFramebuffer framebuffer;
     VkRect2D renderArea;
     uint32_t clearValueCount;
     VkClearValue const * pClearValues;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`CLEARVALUECOUNT FRAMEBUFFER PCLEARVALUES PNEXT RENDERAREA RENDERPASS`	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, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkRenderPassBeginInfo(java.nio.ByteBuffer container)`	Creates a `VkRenderPassBeginInfo` 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 VkRenderPassBeginInfo`	`calloc()`	Returns a new `VkRenderPassBeginInfo` instance allocated with `memCalloc`.
`static VkRenderPassBeginInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated with `memCalloc`.
`static VkRenderPassBeginInfo`	`callocStack()`	Returns a new `VkRenderPassBeginInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassBeginInfo.Buffer`	`callocStack(int capacity)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassBeginInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRenderPassBeginInfo`	`callocStack(MemoryStack stack)`	Returns a new `VkRenderPassBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`clearValueCount()`	Returns the value of the `clearValueCount` field.
`static VkRenderPassBeginInfo`	`create()`	Returns a new `VkRenderPassBeginInfo` instance allocated with `BufferUtils`.
`static VkRenderPassBeginInfo.Buffer`	`create(int capacity)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated with `BufferUtils`.
`static VkRenderPassBeginInfo`	`create(long address)`	Returns a new `VkRenderPassBeginInfo` instance for the specified memory address.
`static VkRenderPassBeginInfo.Buffer`	`create(long address, int capacity)`	Create a `VkRenderPassBeginInfo.Buffer` instance at the specified memory.
`static VkRenderPassBeginInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkRenderPassBeginInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`long`	`framebuffer()`	Returns the value of the `framebuffer` field.
`VkRenderPassBeginInfo`	`framebuffer(long value)`	Sets the specified value to the `framebuffer` field.
`static VkRenderPassBeginInfo`	`malloc()`	Returns a new `VkRenderPassBeginInfo` instance allocated with `memAlloc`.
`static VkRenderPassBeginInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated with `memAlloc`.
`static VkRenderPassBeginInfo`	`mallocStack()`	Returns a new `VkRenderPassBeginInfo` instance allocated on the thread-local `MemoryStack`.
`static VkRenderPassBeginInfo.Buffer`	`mallocStack(int capacity)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkRenderPassBeginInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)`	Returns a new `VkRenderPassBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkRenderPassBeginInfo`	`mallocStack(MemoryStack stack)`	Returns a new `VkRenderPassBeginInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nclearValueCount(long struct)`	Unsafe version of `clearValueCount()`.
`static void`	`nclearValueCount(long struct, int value)`	Sets the specified value to the `clearValueCount` field of the specified `struct`.
`static long`	`nframebuffer(long struct)`	Unsafe version of `framebuffer()`.
`static void`	`nframebuffer(long struct, long value)`	Unsafe version of `framebuffer`.
`static VkClearValue.Buffer`	`npClearValues(long struct)`	Unsafe version of `pClearValues()`.
`static void`	`npClearValues(long struct, VkClearValue.Buffer value)`	Unsafe version of `pClearValues`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static VkRect2D`	`nrenderArea(long struct)`	Unsafe version of `renderArea()`.
`static void`	`nrenderArea(long struct, VkRect2D value)`	Unsafe version of `renderArea`.
`static long`	`nrenderPass(long struct)`	Unsafe version of `renderPass()`.
`static void`	`nrenderPass(long struct, long value)`	Unsafe version of `renderPass`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`VkClearValue.Buffer`	`pClearValues()`	Returns a `VkClearValue.Buffer` view of the struct array pointed to by the `pClearValues` field.
`VkRenderPassBeginInfo`	`pClearValues(VkClearValue.Buffer value)`	Sets the address of the specified `VkClearValue.Buffer` to the `pClearValues` field.
`long`	`pNext()`	Returns the value of the `pNext` field.
`VkRenderPassBeginInfo`	`pNext(long value)`	Sets the specified value to the `pNext` field.
`VkRect2D`	`renderArea()`	Returns a `VkRect2D` view of the `renderArea` field.
`VkRenderPassBeginInfo`	`renderArea(java.util.function.Consumer<VkRect2D> consumer)`	Passes the `renderArea` field to the specified `Consumer`.
`VkRenderPassBeginInfo`	`renderArea(VkRect2D value)`	Copies the specified `VkRect2D` to the `renderArea` field.
`long`	`renderPass()`	Returns the value of the `renderPass` field.
`VkRenderPassBeginInfo`	`renderPass(long value)`	Sets the specified value to the `renderPass` field.
`VkRenderPassBeginInfo`	`set(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, VkClearValue.Buffer pClearValues)`	Initializes this struct with the specified values.
`VkRenderPassBeginInfo`	`set(VkRenderPassBeginInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`	Returns `sizeof(struct)`.
`int`	`sType()`	Returns the value of the `sType` field.
`VkRenderPassBeginInfo`	`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 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

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, RENDERPASS, FRAMEBUFFER, RENDERAREA, CLEARVALUECOUNT, PCLEARVALUES
    
    The struct member offsets.
- Constructor Detail
  - VkRenderPassBeginInfo
```
public VkRenderPassBeginInfo(java.nio.ByteBuffer container)
```
    Creates a VkRenderPassBeginInfo 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()
```
    Description copied from class: Struct
    
    Returns sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - renderPass
```
public long renderPass()
```
    Returns the value of the renderPass field.
  - framebuffer
```
public long framebuffer()
```
    Returns the value of the framebuffer field.
  - renderArea
```
public VkRect2D renderArea()
```
    Returns a VkRect2D view of the renderArea field.
  - renderArea
```
public VkRenderPassBeginInfo renderArea(java.util.function.Consumer<VkRect2D> consumer)
```
    Passes the renderArea field to the specified Consumer.
  - clearValueCount
```
public int clearValueCount()
```
    Returns the value of the clearValueCount field.
  - pClearValues
```
@Nullable
public VkClearValue.Buffer pClearValues()
```
    Returns a VkClearValue.Buffer view of the struct array pointed to by the pClearValues field.
  - sType
```
public VkRenderPassBeginInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkRenderPassBeginInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - renderPass
```
public VkRenderPassBeginInfo renderPass(long value)
```
    Sets the specified value to the renderPass field.
  - framebuffer
```
public VkRenderPassBeginInfo framebuffer(long value)
```
    Sets the specified value to the framebuffer field.
  - renderArea
```
public VkRenderPassBeginInfo renderArea(VkRect2D value)
```
    Copies the specified VkRect2D to the renderArea field.
  - pClearValues
```
public VkRenderPassBeginInfo pClearValues(@Nullable
                                          VkClearValue.Buffer value)
```
    Sets the address of the specified VkClearValue.Buffer to the pClearValues field.
  - set
```
public VkRenderPassBeginInfo set(int sType,
                                 long pNext,
                                 long renderPass,
                                 long framebuffer,
                                 VkRect2D renderArea,
                                 @Nullable
                                 VkClearValue.Buffer pClearValues)
```
    Initializes this struct with the specified values.
  - set
```
public VkRenderPassBeginInfo set(VkRenderPassBeginInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkRenderPassBeginInfo malloc()
```
    Returns a new VkRenderPassBeginInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkRenderPassBeginInfo calloc()
```
    Returns a new VkRenderPassBeginInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkRenderPassBeginInfo create()
```
    Returns a new VkRenderPassBeginInfo instance allocated with BufferUtils.
  - create
```
public static VkRenderPassBeginInfo create(long address)
```
    Returns a new VkRenderPassBeginInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkRenderPassBeginInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkRenderPassBeginInfo.Buffer malloc(int capacity)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkRenderPassBeginInfo.Buffer calloc(int capacity)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRenderPassBeginInfo.Buffer create(int capacity)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRenderPassBeginInfo.Buffer create(long address,
                                                  int capacity)
```
    Create a VkRenderPassBeginInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkRenderPassBeginInfo.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkRenderPassBeginInfo mallocStack()
```
    Returns a new VkRenderPassBeginInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkRenderPassBeginInfo callocStack()
```
    Returns a new VkRenderPassBeginInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkRenderPassBeginInfo mallocStack(MemoryStack stack)
```
    Returns a new VkRenderPassBeginInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkRenderPassBeginInfo callocStack(MemoryStack stack)
```
    Returns a new VkRenderPassBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkRenderPassBeginInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRenderPassBeginInfo.Buffer callocStack(int capacity)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkRenderPassBeginInfo.Buffer mallocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRenderPassBeginInfo.Buffer callocStack(int capacity,
                                                       MemoryStack stack)
```
    Returns a new VkRenderPassBeginInfo.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().
  - nrenderPass
```
public static long nrenderPass(long struct)
```
    Unsafe version of renderPass().
  - nframebuffer
```
public static long nframebuffer(long struct)
```
    Unsafe version of framebuffer().
  - nrenderArea
```
public static VkRect2D nrenderArea(long struct)
```
    Unsafe version of renderArea().
  - nclearValueCount
```
public static int nclearValueCount(long struct)
```
    Unsafe version of clearValueCount().
  - npClearValues
```
@Nullable
public static VkClearValue.Buffer npClearValues(long struct)
```
    Unsafe version of pClearValues().
  - 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.
  - nrenderPass
```
public static void nrenderPass(long struct,
                               long value)
```
    Unsafe version of renderPass.
  - nframebuffer
```
public static void nframebuffer(long struct,
                                long value)
```
    Unsafe version of framebuffer.
  - nrenderArea
```
public static void nrenderArea(long struct,
                               VkRect2D value)
```
    Unsafe version of renderArea.
  - nclearValueCount
```
public static void nclearValueCount(long struct,
                                    int value)
```
    Sets the specified value to the clearValueCount field of the specified struct.
  - npClearValues
```
public static void npClearValues(long struct,
                                 @Nullable
                                 VkClearValue.Buffer value)
```
    Unsafe version of pClearValues.
  - 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 VkRenderPassBeginInfo

Description

Note

Valid Usage

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 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, RENDERPASS, FRAMEBUFFER, RENDERAREA, CLEARVALUECOUNT, PCLEARVALUES

Constructor Detail

VkRenderPassBeginInfo

Method Detail

sizeof

sType

pNext

renderPass

framebuffer

renderArea

renderArea

clearValueCount

pClearValues

sType

pNext

renderPass

framebuffer

renderArea

pClearValues

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nrenderPass

nframebuffer

nrenderArea

nclearValueCount

npClearValues

nsType

npNext

nrenderPass

nframebuffer

nrenderArea

nclearValueCount

npClearValues

validate

validate