Class VkRenderingAreaInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderingAreaInfo>

org.lwjgl.vulkan.VkRenderingAreaInfo

org.lwjgl.vulkan.VkRenderingAreaInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkRenderingAreaInfoKHR
extends VkRenderingAreaInfo

struct VkRenderingAreaInfoKHR {
    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	VkRenderingAreaInfoKHR.Buffer	An array of VkRenderingAreaInfoKHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields inherited from class VkRenderingAreaInfo

ALIGNOF, COLORATTACHMENTCOUNT, DEPTHATTACHMENTFORMAT, PCOLORATTACHMENTFORMATS, PNEXT, SIZEOF, STENCILATTACHMENTFORMAT, STYPE, VIEWMASK

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingAreaInfoKHR	calloc()	Returns a new VkRenderingAreaInfoKHR instance allocated with memCalloc.
static VkRenderingAreaInfoKHR.Buffer	calloc(int capacity)	Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated with memCalloc.
static VkRenderingAreaInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderingAreaInfoKHR	calloc(MemoryStack stack)	Returns a new VkRenderingAreaInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
VkRenderingAreaInfoKHR	colorAttachmentCount(int value)	Sets the specified value to the colorAttachmentCount field.
static VkRenderingAreaInfoKHR	create()	Returns a new VkRenderingAreaInfoKHR instance allocated with BufferUtils.
static VkRenderingAreaInfoKHR.Buffer	create(int capacity)	Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated with BufferUtils.
static VkRenderingAreaInfoKHR	create(long address)	Returns a new VkRenderingAreaInfoKHR instance for the specified memory address.
static VkRenderingAreaInfoKHR.Buffer	create(long address, int capacity)	Create a VkRenderingAreaInfoKHR.Buffer instance at the specified memory.
static @Nullable VkRenderingAreaInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderingAreaInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkRenderingAreaInfoKHR	depthAttachmentFormat(int value)	Sets the specified value to the depthAttachmentFormat field.
static VkRenderingAreaInfoKHR	malloc()	Returns a new VkRenderingAreaInfoKHR instance allocated with memAlloc.
static VkRenderingAreaInfoKHR.Buffer	malloc(int capacity)	Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated with memAlloc.
static VkRenderingAreaInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkRenderingAreaInfoKHR	malloc(MemoryStack stack)	Returns a new VkRenderingAreaInfoKHR instance allocated on the specified MemoryStack.
VkRenderingAreaInfoKHR	pColorAttachmentFormats(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pColorAttachmentFormats field.
VkRenderingAreaInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkRenderingAreaInfoKHR	set(int sType, long pNext, int viewMask, int colorAttachmentCount, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat)	Initializes this struct with the specified values.
VkRenderingAreaInfoKHR	set(VkRenderingAreaInfoKHR src)	Copies the specified struct data to this struct.
VkRenderingAreaInfoKHR	stencilAttachmentFormat(int value)	Sets the specified value to the stencilAttachmentFormat field.
VkRenderingAreaInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkRenderingAreaInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_RENDERING_AREA_INFO value to the sType field.
VkRenderingAreaInfoKHR	viewMask(int value)	Sets the specified value to the viewMask field.

Methods inherited from class VkRenderingAreaInfo

colorAttachmentCount, depthAttachmentFormat, ncolorAttachmentCount, ncolorAttachmentCount, ndepthAttachmentFormat, ndepthAttachmentFormat, npColorAttachmentFormats, npColorAttachmentFormats, npNext, npNext, nstencilAttachmentFormat, nstencilAttachmentFormat, nsType, nsType, nviewMask, nviewMask, pColorAttachmentFormats, pNext, set, sizeof, stencilAttachmentFormat, sType, viewMask

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Constructor Details

VkRenderingAreaInfoKHR

public VkRenderingAreaInfoKHR(ByteBuffer container)

Creates a VkRenderingAreaInfoKHR 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 VkRenderingAreaInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkRenderingAreaInfo

sType$Default

public VkRenderingAreaInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_RENDERING_AREA_INFO value to the sType field.

Overrides:

sType$Default in class VkRenderingAreaInfo

pNext

public VkRenderingAreaInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkRenderingAreaInfo

viewMask

public VkRenderingAreaInfoKHR viewMask(@NativeType("uint32_t")
 int value)

Sets the specified value to the viewMask field.

Overrides:

viewMask in class VkRenderingAreaInfo

colorAttachmentCount

public VkRenderingAreaInfoKHR colorAttachmentCount(@NativeType("uint32_t")
 int value)

Sets the specified value to the colorAttachmentCount field.

Overrides:

colorAttachmentCount in class VkRenderingAreaInfo

pColorAttachmentFormats

public VkRenderingAreaInfoKHR pColorAttachmentFormats(@NativeType("VkFormat const *")
 @Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pColorAttachmentFormats field.

Overrides:

pColorAttachmentFormats in class VkRenderingAreaInfo

depthAttachmentFormat

public VkRenderingAreaInfoKHR depthAttachmentFormat(@NativeType("VkFormat")
 int value)

Sets the specified value to the depthAttachmentFormat field.

Overrides:

depthAttachmentFormat in class VkRenderingAreaInfo

stencilAttachmentFormat

public VkRenderingAreaInfoKHR stencilAttachmentFormat(@NativeType("VkFormat")
 int value)

Sets the specified value to the stencilAttachmentFormat field.

Overrides:

stencilAttachmentFormat in class VkRenderingAreaInfo

set

public VkRenderingAreaInfoKHR set(int sType,
 long pNext,
 int viewMask,
 int colorAttachmentCount,
 @Nullable IntBuffer pColorAttachmentFormats,
 int depthAttachmentFormat,
 int stencilAttachmentFormat)

Initializes this struct with the specified values.

Overrides:

set in class VkRenderingAreaInfo

set

public VkRenderingAreaInfoKHR set(VkRenderingAreaInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderingAreaInfoKHR malloc()

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

calloc

public static VkRenderingAreaInfoKHR calloc()

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

create

public static VkRenderingAreaInfoKHR create()

Returns a new VkRenderingAreaInfoKHR instance allocated with BufferUtils.

create

public static VkRenderingAreaInfoKHR create(long address)

Returns a new VkRenderingAreaInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkRenderingAreaInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAreaInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderingAreaInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderingAreaInfoKHR.Buffer create(int capacity)

Returns a new VkRenderingAreaInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderingAreaInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkRenderingAreaInfoKHR malloc(MemoryStack stack)

Returns a new VkRenderingAreaInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderingAreaInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkRenderingAreaInfoKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderingAreaInfoKHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkRenderingAreaInfoKHR.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