Package org.lwjgl.vulkan

Class VkRenderPassStripeInfoARM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassStripeInfoARM>

org.lwjgl.vulkan.VkRenderPassStripeInfoARM

All Implemented Interfaces:

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

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

Structure specifying per rendering stripe information.

Description

stripeArea is the render area that is affected by this stripe of the render pass instance. It must be a subregion of the renderArea of the render pass instance.

Valid Usage

• stripeArea.offset.x must be a multiple of VkPhysicalDeviceRenderPassStripedPropertiesARM::renderPassStripeGranularity.width
• stripeArea.extent.width must be a multiple of VkPhysicalDeviceRenderPassStripedPropertiesARM::renderPassStripeGranularity.width, or the sum of stripeArea.offset.x and stripeArea.extent.width must be equal to the renderArea.extent.width of the render pass instance
• stripeArea.offset.y must be a multiple of VkPhysicalDeviceRenderPassStripedPropertiesARM::renderPassStripeGranularity.height
• stripeArea.extent.height must be a multiple of VkPhysicalDeviceRenderPassStripedPropertiesARM::renderPassStripeGranularity.height, or the sum of stripeArea.offset.y and stripeArea.extent.height must be equal to the renderArea.extent.height of the render pass instance

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_STRIPE_INFO_ARM
• pNext must be NULL

See Also

VkRect2D, VkRenderPassStripeBeginInfoARM

Layout

 struct VkRenderPassStripeInfoARM {
     VkStructureType sType();
     void const * pNext();
     VkRect2D stripeArea();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderPassStripeInfoARM.Buffer	An array of VkRenderPassStripeInfoARM 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	SIZEOF	The struct size in bytes.
static final int	STRIPEAREA	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
VkRenderPassStripeInfoARM(ByteBuffer container)	Creates a VkRenderPassStripeInfoARM instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkRenderPassStripeInfoARM	calloc()	Returns a new VkRenderPassStripeInfoARM instance allocated with memCalloc.
static VkRenderPassStripeInfoARM.Buffer	calloc(int capacity)	Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated with memCalloc.
static VkRenderPassStripeInfoARM.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassStripeInfoARM	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeInfoARM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassStripeInfoARM	create()	Returns a new VkRenderPassStripeInfoARM instance allocated with BufferUtils.
static VkRenderPassStripeInfoARM.Buffer	create(int capacity)	Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated with BufferUtils.
static VkRenderPassStripeInfoARM	create(long address)	Returns a new VkRenderPassStripeInfoARM instance for the specified memory address.
static VkRenderPassStripeInfoARM.Buffer	create(long address, int capacity)	Create a VkRenderPassStripeInfoARM.Buffer instance at the specified memory.
static @Nullable VkRenderPassStripeInfoARM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkRenderPassStripeInfoARM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderPassStripeInfoARM	malloc()	Returns a new VkRenderPassStripeInfoARM instance allocated with memAlloc.
static VkRenderPassStripeInfoARM.Buffer	malloc(int capacity)	Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated with memAlloc.
static VkRenderPassStripeInfoARM.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassStripeInfoARM	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkRenderPassStripeInfoARM 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 VkRect2D	nstripeArea(long struct)	Unsafe version of stripeArea().
static void	nstripeArea(long struct, VkRect2D value)	Unsafe version of stripeArea.
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.
VkRenderPassStripeInfoARM	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderPassStripeInfoARM	set(int sType, long pNext, VkRect2D stripeArea)	Initializes this struct with the specified values.
VkRenderPassStripeInfoARM	set(VkRenderPassStripeInfoARM src)	Copies the specified struct data to this struct.
int	sizeof()
VkRect2D	stripeArea()	the stripe area, and is described in more detail below.
VkRenderPassStripeInfoARM	stripeArea(Consumer<VkRect2D> consumer)	Passes the stripeArea() field to the specified Consumer.
VkRenderPassStripeInfoARM	stripeArea(VkRect2D value)	Copies the specified VkRect2D to the stripeArea() field.
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassStripeInfoARM	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassStripeInfoARM	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_STRIPE_INFO_ARM 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.

STRIPEAREA

public static final int STRIPEAREA

The struct member offsets.

Constructor Details

VkRenderPassStripeInfoARM

public VkRenderPassStripeInfoARM(ByteBuffer container)

Creates a VkRenderPassStripeInfoARM 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<VkRenderPassStripeInfoARM>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stripeArea

public VkRect2D stripeArea()

the stripe area, and is described in more detail below.

sType

public VkRenderPassStripeInfoARM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassStripeInfoARM sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_STRIPE_INFO_ARM value to the sType() field.

pNext

public VkRenderPassStripeInfoARM pNext(long value)

Sets the specified value to the pNext() field.

stripeArea

public VkRenderPassStripeInfoARM stripeArea(VkRect2D value)

Copies the specified VkRect2D to the stripeArea() field.

stripeArea

public VkRenderPassStripeInfoARM stripeArea(Consumer<VkRect2D> consumer)

Passes the stripeArea() field to the specified Consumer.

set

public VkRenderPassStripeInfoARM set(int sType,
 long pNext,
 VkRect2D stripeArea)

Initializes this struct with the specified values.

set

public VkRenderPassStripeInfoARM set(VkRenderPassStripeInfoARM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassStripeInfoARM malloc()

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

calloc

public static VkRenderPassStripeInfoARM calloc()

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

create

public static VkRenderPassStripeInfoARM create()

Returns a new VkRenderPassStripeInfoARM instance allocated with BufferUtils.

create

public static VkRenderPassStripeInfoARM create(long address)

Returns a new VkRenderPassStripeInfoARM instance for the specified memory address.

createSafe

public static @Nullable VkRenderPassStripeInfoARM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassStripeInfoARM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassStripeInfoARM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassStripeInfoARM.Buffer create(int capacity)

Returns a new VkRenderPassStripeInfoARM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkRenderPassStripeInfoARM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkRenderPassStripeInfoARM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nstripeArea

public static VkRect2D nstripeArea(long struct)

Unsafe version of stripeArea().

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.

nstripeArea

public static void nstripeArea(long struct,
 VkRect2D value)

Unsafe version of stripeArea.