Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRenderingInfoKHR

extends VkRenderingInfo
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Inherited from org.lwjgl.vulkan.VkRenderingInfo:
ALIGNOFCOLORATTACHMENTCOUNTFLAGSLAYERCOUNTPCOLORATTACHMENTSPDEPTHATTACHMENTPNEXTPSTENCILATTACHMENTRENDERAREASIZEOFSTYPEVIEWMASK

Constructor Summary

AccessConstructor and Description
protected
VkRenderingInfoKHR(long address, ByteBuffer container)

public
VkRenderingInfoKHR(ByteBuffer container)

Creates a VkRenderingInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkRenderingInfoKHR
calloc()

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

Returns a new VkRenderingInfoKHR instance allocated with memCalloc.
public static VkRenderingInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

Returns a new VkRenderingInfoKHR.Buffer instance allocated with memCalloc.
public static VkRenderingInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkRenderingInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
protected VkRenderingInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Overrides org.lwjgl.vulkan.VkRenderingInfo.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkRenderingInfoKHR
create()

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR instance allocated with BufferUtils.
public static VkRenderingInfoKHR
create(long address)

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR instance for the specified memory address.
public static VkRenderingInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR.Buffer instance allocated with BufferUtils.
public static VkRenderingInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Create a VkRenderingInfoKHR.Buffer instance at the specified memory.
public static VkRenderingInfoKHR
createSafe(long address)

Hides org.lwjgl.vulkan.VkRenderingInfo.createSafe.

Like create, but returns null if address is NULL.
public static VkRenderingInfoKHR.Buffer
createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkRenderingInfo.createSafe.

Like create, but returns null if address is NULL.
public VkRenderingInfoKHR
flags(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.flags.

Sets the specified value to the flags field.
public VkRenderingInfoKHR
layerCount(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.layerCount.

Sets the specified value to the layerCount field.
public static VkRenderingInfoKHR
malloc()

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

Returns a new VkRenderingInfoKHR instance allocated with memAlloc.
public static VkRenderingInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

Returns a new VkRenderingInfoKHR.Buffer instance allocated with memAlloc.
public static VkRenderingInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack.
public static VkRenderingInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

Returns a new VkRenderingInfoKHR.Buffer instance allocated on the specified MemoryStack.
public VkRenderingInfoKHR
pColorAttachments(VkRenderingAttachmentInfo.Buffer value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pColorAttachments.

Sets the address of the specified VkRenderingAttachmentInfo.Buffer to the pColorAttachments field.
public VkRenderingInfoKHR
pDepthAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pDepthAttachment.

Sets the address of the specified VkRenderingAttachmentInfo to the pDepthAttachment field.
public VkRenderingInfoKHR
pNext(long value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pNext.

Sets the specified value to the pNext field.
public VkRenderingInfoKHR
pStencilAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pStencilAttachment.

Sets the address of the specified VkRenderingAttachmentInfo to the pStencilAttachment field.
public VkRenderingInfoKHR
renderArea(VkRect2D value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.renderArea.

Copies the specified VkRect2D to the renderArea field.
public VkRenderingInfoKHR
renderArea(Consumer<VkRect2D> consumer)

Overrides org.lwjgl.vulkan.VkRenderingInfo.renderArea.

Passes the renderArea field to the specified Consumer.
public VkRenderingInfoKHR
set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, VkRenderingAttachmentInfo.Buffer pColorAttachments, VkRenderingAttachmentInfo pDepthAttachment, VkRenderingAttachmentInfo pStencilAttachment)

Overrides org.lwjgl.vulkan.VkRenderingInfo.set.

Initializes this struct with the specified values.
public VkRenderingInfoKHR

Returns:

this struct
set
(VkRenderingInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public VkRenderingInfoKHR
sType(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.sType.

Sets the specified value to the sType field.
public VkRenderingInfoKHR
public VkRenderingInfoKHR
viewMask(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.viewMask.

Sets the specified value to the viewMask field.
Inherited from org.lwjgl.vulkan.VkRenderingInfo:
colorAttachmentCountflagslayerCountncolorAttachmentCountncolorAttachmentCountnflagsnflagsnlayerCountnlayerCountnpColorAttachmentsnpColorAttachmentsnpDepthAttachmentnpDepthAttachmentnpNextnpNextnpStencilAttachmentnpStencilAttachmentnrenderAreanrenderAreansTypensTypenviewMasknviewMaskpColorAttachmentspDepthAttachmentpNextpNextpNextpNextpNextpNextpNextpNextpStencilAttachmentrenderAreasetsizeofsTypevalidateviewMask

Constructor Detail

VkRenderingInfoKHRback to summary
protected VkRenderingInfoKHR(long address, ByteBuffer container)
VkRenderingInfoKHRback to summary
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 Detail

callocback to summary
public static VkRenderingInfoKHR calloc()

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

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

callocback to summary
public static VkRenderingInfoKHR.Buffer calloc(int capacity)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRenderingInfoKHR calloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkRenderingInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Hides org.lwjgl.vulkan.VkRenderingInfo.calloc.

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkRenderingInfoKHR create(long address, ByteBuffer container)

Overrides org.lwjgl.vulkan.VkRenderingInfo.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkRenderingInfoKHR create()

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkRenderingInfoKHR create(long address)

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR instance for the specified memory address.

createback to summary
public static VkRenderingInfoKHR.Buffer create(int capacity)

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Returns a new VkRenderingInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Hides org.lwjgl.vulkan.VkRenderingInfo.create.

Create a VkRenderingInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRenderingInfoKHR createSafe(long address)

Hides org.lwjgl.vulkan.VkRenderingInfo.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkRenderingInfoKHR.Buffer createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkRenderingInfo.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public VkRenderingInfoKHR flags(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.flags.

Sets the specified value to the flags field.

Annotations
@Override
layerCountback to summary
public VkRenderingInfoKHR layerCount(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.layerCount.

Sets the specified value to the layerCount field.

Annotations
@Override
mallocback to summary
public static VkRenderingInfoKHR malloc()

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

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

mallocback to summary
public static VkRenderingInfoKHR.Buffer malloc(int capacity)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRenderingInfoKHR malloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

Returns a new VkRenderingInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkRenderingInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

Hides org.lwjgl.vulkan.VkRenderingInfo.malloc.

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

pColorAttachmentsback to summary
public VkRenderingInfoKHR pColorAttachments(VkRenderingAttachmentInfo.Buffer value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pColorAttachments.

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

Annotations
@Override
pDepthAttachmentback to summary
public VkRenderingInfoKHR pDepthAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pDepthAttachment.

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

Annotations
@Override
pNextback to summary
public VkRenderingInfoKHR pNext(long value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
pStencilAttachmentback to summary
public VkRenderingInfoKHR pStencilAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.pStencilAttachment.

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

Annotations
@Override
renderAreaback to summary
public VkRenderingInfoKHR renderArea(VkRect2D value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.renderArea.

Copies the specified VkRect2D to the renderArea field.

Annotations
@Override
renderAreaback to summary
public VkRenderingInfoKHR renderArea(Consumer<VkRect2D> consumer)

Overrides org.lwjgl.vulkan.VkRenderingInfo.renderArea.

Passes the renderArea field to the specified Consumer.

Annotations
@Override
setback to summary
public VkRenderingInfoKHR set(int sType, long pNext, int flags, VkRect2D renderArea, int layerCount, int viewMask, VkRenderingAttachmentInfo.Buffer pColorAttachments, VkRenderingAttachmentInfo pDepthAttachment, VkRenderingAttachmentInfo pStencilAttachment)

Overrides org.lwjgl.vulkan.VkRenderingInfo.set.

Initializes this struct with the specified values.

Annotations
@Override
setback to summary
public VkRenderingInfoKHR set(VkRenderingInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkRenderingInfoKHR

the source struct

Returns:VkRenderingInfoKHR

this struct

sTypeback to summary
public VkRenderingInfoKHR sType(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkRenderingInfoKHR sType$Default()

Overrides org.lwjgl.vulkan.VkRenderingInfo.sType$Default.

Sets the STRUCTURE_TYPE_RENDERING_INFO value to the sType field.

Annotations
@Override
viewMaskback to summary
public VkRenderingInfoKHR viewMask(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.viewMask.

Sets the specified value to the viewMask field.

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkRenderingInfoKHR.Buffer

extends Buffer
Class Inheritance

An array of VkRenderingInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkRenderingInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRenderingInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public VkRenderingInfoKHR.Buffer
flags(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.flags.

Sets the specified value to the flags field.
protected VkRenderingInfoKHR
public VkRenderingInfoKHR.Buffer
layerCount(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.layerCount.

Sets the specified value to the layerCount field.
public VkRenderingInfoKHR.Buffer
public VkRenderingInfoKHR.Buffer
pDepthAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pDepthAttachment.

Sets the address of the specified VkRenderingAttachmentInfo to the pDepthAttachment field.
public VkRenderingInfoKHR.Buffer
pNext(long value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pNext.

Sets the specified value to the pNext field.
public VkRenderingInfoKHR.Buffer
pStencilAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pStencilAttachment.

Sets the address of the specified VkRenderingAttachmentInfo to the pStencilAttachment field.
public VkRenderingInfoKHR.Buffer
renderArea(VkRect2D value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.renderArea.

Copies the specified VkRect2D to the renderArea field.
public VkRenderingInfoKHR.Buffer
renderArea(Consumer<VkRect2D> consumer)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.renderArea.

Passes the renderArea field to the specified Consumer.
protected VkRenderingInfoKHR.Buffer
public VkRenderingInfoKHR.Buffer
sType(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.sType.

Sets the specified value to the sType field.
public VkRenderingInfoKHR.Buffer
public VkRenderingInfoKHR.Buffer
viewMask(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.viewMask.

Sets the specified value to the viewMask field.
Inherited from org.lwjgl.vulkan.VkRenderingInfo.Buffer:
colorAttachmentCountflagslayerCountpColorAttachmentspDepthAttachmentpNextpNextpNextpNextpNextpNextpNextpNextpStencilAttachmentrenderAreasTypeviewMask

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRenderingInfoKHR ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkRenderingInfo.Buffer.ELEMENT_FACTORY.

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkRenderingInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkRenderingInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flagsback to summary
public VkRenderingInfoKHR.Buffer flags(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.flags.

Sets the specified value to the flags field.

Annotations
@Override
getElementFactoryback to summary
protected VkRenderingInfoKHR getElementFactory()

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.getElementFactory.

Annotations
@Override
layerCountback to summary
public VkRenderingInfoKHR.Buffer layerCount(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.layerCount.

Sets the specified value to the layerCount field.

Annotations
@Override
pColorAttachmentsback to summary
public VkRenderingInfoKHR.Buffer pColorAttachments(VkRenderingAttachmentInfo.Buffer value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pColorAttachments.

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

Annotations
@Override
pDepthAttachmentback to summary
public VkRenderingInfoKHR.Buffer pDepthAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pDepthAttachment.

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

Annotations
@Override
pNextback to summary
public VkRenderingInfoKHR.Buffer pNext(long value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
pStencilAttachmentback to summary
public VkRenderingInfoKHR.Buffer pStencilAttachment(VkRenderingAttachmentInfo value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.pStencilAttachment.

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

Annotations
@Override
renderAreaback to summary
public VkRenderingInfoKHR.Buffer renderArea(VkRect2D value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.renderArea.

Copies the specified VkRect2D to the renderArea field.

Annotations
@Override
renderAreaback to summary
public VkRenderingInfoKHR.Buffer renderArea(Consumer<VkRect2D> consumer)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.renderArea.

Passes the renderArea field to the specified Consumer.

Annotations
@Override
selfback to summary
protected VkRenderingInfoKHR.Buffer self()

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.self.

Annotations
@Override
sTypeback to summary
public VkRenderingInfoKHR.Buffer sType(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkRenderingInfoKHR.Buffer sType$Default()

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_RENDERING_INFO value to the sType field.

Annotations
@Override
viewMaskback to summary
public VkRenderingInfoKHR.Buffer viewMask(int value)

Overrides org.lwjgl.vulkan.VkRenderingInfo.Buffer.viewMask.

Sets the specified value to the viewMask field.

Annotations
@Override