Package org.lwjgl.vulkan

Class VkRenderPassStripeBeginInfoARM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassStripeBeginInfoARM>

org.lwjgl.vulkan.VkRenderPassStripeBeginInfoARM

All Implemented Interfaces:

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

public class VkRenderPassStripeBeginInfoARM
extends org.lwjgl.system.Struct<VkRenderPassStripeBeginInfoARM>
implements org.lwjgl.system.NativeResource

Structure specifying striped rendering information.

Description

This structure can be included in the pNext chain of VkRenderPassBeginInfo or VkRenderingInfo to define how the render pass instance is split into stripes.

Valid Usage

• stripeInfoCount must be less than or equal to VkPhysicalDeviceRenderPassStripedPropertiesARM::maxRenderPassStripes
• The stripeArea defined by each element of pStripeInfos must not overlap the stripeArea of any other element

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_STRIPE_BEGIN_INFO_ARM
• pStripeInfos must be a valid pointer to an array of stripeInfoCount valid VkRenderPassStripeInfoARM structures
• stripeInfoCount must be greater than 0

See Also

VkRenderPassStripeInfoARM

Layout

 struct VkRenderPassStripeBeginInfoARM {
     VkStructureType sType();
     void const * pNext();
     uint32_t stripeInfoCount();
     VkRenderPassStripeInfoARM const * pStripeInfos();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderPassStripeBeginInfoARM.Buffer	An array of VkRenderPassStripeBeginInfoARM 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

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

Method Summary

Modifier and Type	Method	Description
static VkRenderPassStripeBeginInfoARM	calloc()	Returns a new VkRenderPassStripeBeginInfoARM instance allocated with memCalloc.
static VkRenderPassStripeBeginInfoARM.Buffer	calloc(int capacity)	Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated with memCalloc.
static VkRenderPassStripeBeginInfoARM.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassStripeBeginInfoARM	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeBeginInfoARM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassStripeBeginInfoARM	create()	Returns a new VkRenderPassStripeBeginInfoARM instance allocated with BufferUtils.
static VkRenderPassStripeBeginInfoARM.Buffer	create(int capacity)	Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated with BufferUtils.
static VkRenderPassStripeBeginInfoARM	create(long address)	Returns a new VkRenderPassStripeBeginInfoARM instance for the specified memory address.
static VkRenderPassStripeBeginInfoARM.Buffer	create(long address, int capacity)	Create a VkRenderPassStripeBeginInfoARM.Buffer instance at the specified memory.
static @Nullable VkRenderPassStripeBeginInfoARM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderPassStripeBeginInfoARM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderPassStripeBeginInfoARM	malloc()	Returns a new VkRenderPassStripeBeginInfoARM instance allocated with memAlloc.
static VkRenderPassStripeBeginInfoARM.Buffer	malloc(int capacity)	Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated with memAlloc.
static VkRenderPassStripeBeginInfoARM.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassStripeBeginInfoARM	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeBeginInfoARM instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkRenderPassStripeInfoARM.Buffer	npStripeInfos(long struct)	Unsafe version of pStripeInfos().
static void	npStripeInfos(long struct, VkRenderPassStripeInfoARM.Buffer value)	Unsafe version of pStripeInfos.
static int	nstripeInfoCount(long struct)	Unsafe version of stripeInfoCount().
static void	nstripeInfoCount(long struct, int value)	Sets the specified value to the stripeInfoCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRenderPassStripeBeginInfoARM	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderPassStripeInfoARM.Buffer	pStripeInfos()	a pointer to an array of stripeInfoCount VkRenderPassStripeInfoARM structures describing the stripes used by the render pass instance.
VkRenderPassStripeBeginInfoARM	pStripeInfos(VkRenderPassStripeInfoARM.Buffer value)	Sets the address of the specified VkRenderPassStripeInfoARM.Buffer to the pStripeInfos() field.
VkRenderPassStripeBeginInfoARM	set(int sType, long pNext, VkRenderPassStripeInfoARM.Buffer pStripeInfos)	Initializes this struct with the specified values.
VkRenderPassStripeBeginInfoARM	set(VkRenderPassStripeBeginInfoARM src)	Copies the specified struct data to this struct.
int	sizeof()
int	stripeInfoCount()	the number of stripes in this render pass instance
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassStripeBeginInfoARM	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassStripeBeginInfoARM	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_STRIPE_BEGIN_INFO_ARM value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

STRIPEINFOCOUNT

public static final int STRIPEINFOCOUNT

The struct member offsets.

PSTRIPEINFOS

public static final int PSTRIPEINFOS

The struct member offsets.

Constructor Details

VkRenderPassStripeBeginInfoARM

public VkRenderPassStripeBeginInfoARM(ByteBuffer container)

Creates a VkRenderPassStripeBeginInfoARM 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkRenderPassStripeBeginInfoARM>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stripeInfoCount

public int stripeInfoCount()

the number of stripes in this render pass instance

pStripeInfos

public VkRenderPassStripeInfoARM.Buffer pStripeInfos()

a pointer to an array of stripeInfoCount VkRenderPassStripeInfoARM structures describing the stripes used by the render pass instance.

sType

public VkRenderPassStripeBeginInfoARM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassStripeBeginInfoARM sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_STRIPE_BEGIN_INFO_ARM value to the sType() field.

pNext

public VkRenderPassStripeBeginInfoARM pNext(long value)

Sets the specified value to the pNext() field.

pStripeInfos

public VkRenderPassStripeBeginInfoARM pStripeInfos(VkRenderPassStripeInfoARM.Buffer value)

Sets the address of the specified VkRenderPassStripeInfoARM.Buffer to the pStripeInfos() field.

set

public VkRenderPassStripeBeginInfoARM set(int sType,
 long pNext,
 VkRenderPassStripeInfoARM.Buffer pStripeInfos)

Initializes this struct with the specified values.

set

public VkRenderPassStripeBeginInfoARM set(VkRenderPassStripeBeginInfoARM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassStripeBeginInfoARM malloc()

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

calloc

public static VkRenderPassStripeBeginInfoARM calloc()

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

create

public static VkRenderPassStripeBeginInfoARM create()

Returns a new VkRenderPassStripeBeginInfoARM instance allocated with BufferUtils.

create

public static VkRenderPassStripeBeginInfoARM create(long address)

Returns a new VkRenderPassStripeBeginInfoARM instance for the specified memory address.

createSafe

public static @Nullable VkRenderPassStripeBeginInfoARM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassStripeBeginInfoARM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassStripeBeginInfoARM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassStripeBeginInfoARM.Buffer create(int capacity)

Returns a new VkRenderPassStripeBeginInfoARM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderPassStripeBeginInfoARM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkRenderPassStripeBeginInfoARM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkRenderPassStripeBeginInfoARM.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().

nstripeInfoCount

public static int nstripeInfoCount(long struct)

Unsafe version of stripeInfoCount().

npStripeInfos

public static VkRenderPassStripeInfoARM.Buffer npStripeInfos(long struct)

Unsafe version of pStripeInfos().

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.

nstripeInfoCount

public static void nstripeInfoCount(long struct,
 int value)

Sets the specified value to the stripeInfoCount field of the specified struct.

npStripeInfos

public static void npStripeInfos(long struct,
 VkRenderPassStripeInfoARM.Buffer value)

Unsafe version of pStripeInfos.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate