Package org.lwjgl.vulkan

Class VkRenderingInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingInfo>

org.lwjgl.vulkan.VkRenderingInfo

org.lwjgl.vulkan.VkRenderingInfoKHR

All Implemented Interfaces:

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

public class VkRenderingInfoKHR
extends VkRenderingInfo

See VkRenderingInfo.

Layout

 struct VkRenderingInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkRenderingFlags flags;
     VkRect2D renderArea;
     uint32_t layerCount;
     uint32_t viewMask;
     uint32_t colorAttachmentCount;
     VkRenderingAttachmentInfo const * pColorAttachments;
     VkRenderingAttachmentInfo const * pDepthAttachment;
     VkRenderingAttachmentInfo const * pStencilAttachment;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderingInfoKHR.Buffer	An array of VkRenderingInfoKHR structs.

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields inherited from class org.lwjgl.vulkan.VkRenderingInfo

ALIGNOF, COLORATTACHMENTCOUNT, FLAGS, LAYERCOUNT, PCOLORATTACHMENTS, PDEPTHATTACHMENT, PNEXT, PSTENCILATTACHMENT, RENDERAREA, SIZEOF, STYPE, VIEWMASK

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkRenderingInfoKHR(ByteBuffer container)	Creates a VkRenderingInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkRenderingInfoKHR	calloc()	Returns a new VkRenderingInfoKHR instance allocated with memCalloc.
static VkRenderingInfoKHR.Buffer	calloc(int capacity)	Returns a new VkRenderingInfoKHR.Buffer instance allocated with memCalloc.
static VkRenderingInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingInfoKHR	create()	Returns a new VkRenderingInfoKHR instance allocated with BufferUtils.
static VkRenderingInfoKHR.Buffer	create(int capacity)	Returns a new VkRenderingInfoKHR.Buffer instance allocated with BufferUtils.
static VkRenderingInfoKHR	create(long address)	Returns a new VkRenderingInfoKHR instance for the specified memory address.
static VkRenderingInfoKHR.Buffer	create(long address, int capacity)	Create a VkRenderingInfoKHR.Buffer instance at the specified memory.
static @Nullable VkRenderingInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkRenderingInfoKHR	flags(int value)	Sets the specified value to the flags field.
VkRenderingInfoKHR	layerCount(int value)	Sets the specified value to the layerCount field.
static VkRenderingInfoKHR	malloc()	Returns a new VkRenderingInfoKHR instance allocated with memAlloc.
static VkRenderingInfoKHR.Buffer	malloc(int capacity)	Returns a new VkRenderingInfoKHR.Buffer instance allocated with memAlloc.
static VkRenderingInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkRenderingInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack.
VkRenderingInfoKHR	pColorAttachments(@Nullable VkRenderingAttachmentInfo.Buffer value)	Sets the address of the specified VkRenderingAttachmentInfo.Buffer to the pColorAttachments field.
VkRenderingInfoKHR	pDepthAttachment(@Nullable VkRenderingAttachmentInfo value)	Sets the address of the specified VkRenderingAttachmentInfo to the pDepthAttachment field.
VkRenderingInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkRenderingInfoKHR	pStencilAttachment(@Nullable VkRenderingAttachmentInfo value)	Sets the address of the specified VkRenderingAttachmentInfo to the pStencilAttachment field.
VkRenderingInfoKHR	renderArea(Consumer<VkRect2D> consumer)	Passes the renderArea field to the specified Consumer.
VkRenderingInfoKHR	renderArea(VkRect2D value)	Copies the specified VkRect2D to the renderArea field.
VkRenderingInfoKHR	set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, @Nullable VkRenderingAttachmentInfo.Buffer pColorAttachments, @Nullable VkRenderingAttachmentInfo pDepthAttachment, @Nullable VkRenderingAttachmentInfo pStencilAttachment)	Initializes this struct with the specified values.
VkRenderingInfoKHR	set(VkRenderingInfoKHR src)	Copies the specified struct data to this struct.
VkRenderingInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkRenderingInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_INFO value to the sType field.
VkRenderingInfoKHR	viewMask(int value)	Sets the specified value to the viewMask field.

Methods inherited from class org.lwjgl.vulkan.VkRenderingInfo

colorAttachmentCount, flags, layerCount, ncolorAttachmentCount, ncolorAttachmentCount, nflags, nflags, nlayerCount, nlayerCount, npColorAttachments, npColorAttachments, npDepthAttachment, npDepthAttachment, npNext, npNext, npStencilAttachment, npStencilAttachment, nrenderArea, nrenderArea, nsType, nsType, nviewMask, nviewMask, pColorAttachments, pDepthAttachment, pNext, pNext, pNext, pNext, pNext, pNext, pNext, pNext, pNext, pStencilAttachment, renderArea, set, sizeof, sType, validate, viewMask

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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

Constructor Details

VkRenderingInfoKHR

public VkRenderingInfoKHR(ByteBuffer container)

Creates a VkRenderingInfoKHR 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 Details

sType

public VkRenderingInfoKHR sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkRenderingInfo

sType$Default

public VkRenderingInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_INFO value to the sType field.

Overrides:

sType$Default in class VkRenderingInfo

pNext

public VkRenderingInfoKHR pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkRenderingInfo

flags

public VkRenderingInfoKHR flags(int value)

Sets the specified value to the flags field.

Overrides:

flags in class VkRenderingInfo

renderArea

public VkRenderingInfoKHR renderArea(VkRect2D value)

Copies the specified VkRect2D to the renderArea field.

Overrides:

renderArea in class VkRenderingInfo

renderArea

public VkRenderingInfoKHR renderArea(Consumer<VkRect2D> consumer)

Passes the renderArea field to the specified Consumer.

Overrides:

renderArea in class VkRenderingInfo

layerCount

public VkRenderingInfoKHR layerCount(int value)

Sets the specified value to the layerCount field.

Overrides:

layerCount in class VkRenderingInfo

viewMask

public VkRenderingInfoKHR viewMask(int value)

Sets the specified value to the viewMask field.

Overrides:

viewMask in class VkRenderingInfo

pColorAttachments

public VkRenderingInfoKHR pColorAttachments(@Nullable VkRenderingAttachmentInfo.Buffer value)

Sets the address of the specified VkRenderingAttachmentInfo.Buffer to the pColorAttachments field.

Overrides:

pColorAttachments in class VkRenderingInfo

pDepthAttachment

public VkRenderingInfoKHR pDepthAttachment(@Nullable VkRenderingAttachmentInfo value)

Sets the address of the specified VkRenderingAttachmentInfo to the pDepthAttachment field.

Overrides:

pDepthAttachment in class VkRenderingInfo

pStencilAttachment

public VkRenderingInfoKHR pStencilAttachment(@Nullable VkRenderingAttachmentInfo value)

Sets the address of the specified VkRenderingAttachmentInfo to the pStencilAttachment field.

Overrides:

pStencilAttachment in class VkRenderingInfo

set

public VkRenderingInfoKHR set(int sType,
 long pNext,
 int flags,
 VkRect2D renderArea,
 int layerCount,
 int viewMask,
 @Nullable VkRenderingAttachmentInfo.Buffer pColorAttachments,
 @Nullable VkRenderingAttachmentInfo pDepthAttachment,
 @Nullable VkRenderingAttachmentInfo pStencilAttachment)

Initializes this struct with the specified values.

Overrides:

set in class VkRenderingInfo

set

public VkRenderingInfoKHR set(VkRenderingInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingInfoKHR malloc()

Returns a new VkRenderingInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkRenderingInfoKHR calloc()

Returns a new VkRenderingInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkRenderingInfoKHR create()

Returns a new VkRenderingInfoKHR instance allocated with BufferUtils.

create

public static VkRenderingInfoKHR create(long address)

Returns a new VkRenderingInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkRenderingInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingInfoKHR.Buffer malloc(int capacity)

Returns a new VkRenderingInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingInfoKHR.Buffer calloc(int capacity)

Returns a new VkRenderingInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkRenderingInfoKHR.Buffer create(int capacity)

Returns a new VkRenderingInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkRenderingInfoKHR.Buffer create(long address,
 int capacity)

Create a VkRenderingInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkRenderingInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderingInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkRenderingInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderingInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate