Package org.lwjgl.vulkan

Class VkRenderPassBeginInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassBeginInfo>

org.lwjgl.vulkan.VkRenderPassBeginInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkRenderPassBeginInfo
extends Struct<VkRenderPassBeginInfo>
implements NativeResource

 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 class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CLEARVALUECOUNT	The struct member offsets.
static final int	FRAMEBUFFER	The struct member offsets.
static final int	PCLEARVALUES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	RENDERAREA	The struct member offsets.
static final int	RENDERPASS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkRenderPassBeginInfo(ByteBuffer container)	Creates a VkRenderPassBeginInfo instance at the current position of the specified ByteBuffer container.

Method Summary

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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassBeginInfo	calloc(MemoryStack stack)	Returns a new VkRenderPassBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	clearValueCount()
VkRenderPassBeginInfo	clearValueCount(int value)	Sets the specified value to 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 @Nullable VkRenderPassBeginInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderPassBeginInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	framebuffer()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassBeginInfo.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassBeginInfo	malloc(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 @Nullable VkClearValue.Buffer	npClearValues(long struct)	Unsafe version of pClearValues().
static void	npClearValues(long struct, @Nullable 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.
@Nullable VkClearValue.Buffer	pClearValues()
VkRenderPassBeginInfo	pClearValues(@Nullable VkClearValue.Buffer value)	Sets the address of the specified VkClearValue.Buffer to the pClearValues field.
long	pNext()
VkRenderPassBeginInfo	pNext(long value)	Sets the specified value to the pNext field.
VkRenderPassBeginInfo	pNext(VkDeviceGroupRenderPassBeginInfo value)	Prepends the specified VkDeviceGroupRenderPassBeginInfo value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkDeviceGroupRenderPassBeginInfoKHR value)	Prepends the specified VkDeviceGroupRenderPassBeginInfoKHR value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM value)	Prepends the specified VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassAttachmentBeginInfo value)	Prepends the specified VkRenderPassAttachmentBeginInfo value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassAttachmentBeginInfoKHR value)	Prepends the specified VkRenderPassAttachmentBeginInfoKHR value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassPerformanceCountersByRegionBeginInfoARM value)	Prepends the specified VkRenderPassPerformanceCountersByRegionBeginInfoARM value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassSampleLocationsBeginInfoEXT value)	Prepends the specified VkRenderPassSampleLocationsBeginInfoEXT value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassStripeBeginInfoARM value)	Prepends the specified VkRenderPassStripeBeginInfoARM value to the pNext chain.
VkRenderPassBeginInfo	pNext(VkRenderPassTransformBeginInfoQCOM value)	Prepends the specified VkRenderPassTransformBeginInfoQCOM value to the pNext chain.
VkRect2D	renderArea()
VkRenderPassBeginInfo	renderArea(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()
VkRenderPassBeginInfo	renderPass(long value)	Sets the specified value to the renderPass field.
VkRenderPassBeginInfo	set(int sType, long pNext, long renderPass, long framebuffer, VkRect2D renderArea, int clearValueCount, @Nullable 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()
VkRenderPassBeginInfo	sType(int value)	Sets the specified value to the sType field.
VkRenderPassBeginInfo	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO value to the sType field.

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

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

RENDERPASS

public static final int RENDERPASS

The struct member offsets.

FRAMEBUFFER

public static final int FRAMEBUFFER

The struct member offsets.

RENDERAREA

public static final int RENDERAREA

The struct member offsets.

CLEARVALUECOUNT

public static final int CLEARVALUECOUNT

The struct member offsets.

PCLEARVALUES

public static final int PCLEARVALUES

The struct member offsets.

Constructor Details

VkRenderPassBeginInfo

public VkRenderPassBeginInfo(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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkRenderPassBeginInfo>

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.

clearValueCount

public int clearValueCount()

Returns:

the value of the clearValueCount field.

pClearValues

public @Nullable 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.

sType$Default

public VkRenderPassBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO value to the sType field.

pNext

public VkRenderPassBeginInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkRenderPassBeginInfo pNext(VkDeviceGroupRenderPassBeginInfo value)

Prepends the specified VkDeviceGroupRenderPassBeginInfo value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkDeviceGroupRenderPassBeginInfoKHR value)

Prepends the specified VkDeviceGroupRenderPassBeginInfoKHR value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM value)

Prepends the specified VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassAttachmentBeginInfo value)

Prepends the specified VkRenderPassAttachmentBeginInfo value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassAttachmentBeginInfoKHR value)

Prepends the specified VkRenderPassAttachmentBeginInfoKHR value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassPerformanceCountersByRegionBeginInfoARM value)

Prepends the specified VkRenderPassPerformanceCountersByRegionBeginInfoARM value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassSampleLocationsBeginInfoEXT value)

Prepends the specified VkRenderPassSampleLocationsBeginInfoEXT value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassStripeBeginInfoARM value)

Prepends the specified VkRenderPassStripeBeginInfoARM value to the pNext chain.

pNext

public VkRenderPassBeginInfo pNext(VkRenderPassTransformBeginInfoQCOM value)

Prepends the specified VkRenderPassTransformBeginInfoQCOM value to the pNext chain.

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.

renderArea

public VkRenderPassBeginInfo renderArea(Consumer<VkRect2D> consumer)

Passes the renderArea field to the specified Consumer.

clearValueCount

public VkRenderPassBeginInfo clearValueCount(int value)

Sets the specified value to the clearValueCount 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,
 int clearValueCount,
 @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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassBeginInfo malloc(MemoryStack stack)

Returns a new VkRenderPassBeginInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderPassBeginInfo calloc(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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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

public static @Nullable 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.