Package org.lwjgl.vulkan

Class VkTilePropertiesQCOM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkTilePropertiesQCOM>

org.lwjgl.vulkan.VkTilePropertiesQCOM

All Implemented Interfaces:

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

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

Structure holding available tile properties.

Description

All tiles will be tightly packed around the first tile, with edges being multiples of tile width and/or height from the origin.

Note

Reported value for apronSize will be zero and its functionality will be described in a future extension.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_TILE_PROPERTIES_QCOM
• pNext must be NULL

See Also

VkExtent2D, VkExtent3D, VkOffset2D, GetDynamicRenderingTilePropertiesQCOM, GetFramebufferTilePropertiesQCOM

Layout

 struct VkTilePropertiesQCOM {
     VkStructureType sType();
     void * pNext();
     VkExtent3D tileSize();
     VkExtent2D apronSize();
     VkOffset2D origin();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
VkExtent2D	apronSize()	the dimension of the apron.
VkTilePropertiesQCOM	apronSize(Consumer<VkExtent2D> consumer)	Passes the apronSize() field to the specified Consumer.
VkTilePropertiesQCOM	apronSize(VkExtent2D value)	Copies the specified VkExtent2D to the apronSize() field.
static VkTilePropertiesQCOM	calloc()	Returns a new VkTilePropertiesQCOM instance allocated with memCalloc.
static VkTilePropertiesQCOM.Buffer	calloc(int capacity)	Returns a new VkTilePropertiesQCOM.Buffer instance allocated with memCalloc.
static VkTilePropertiesQCOM.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTilePropertiesQCOM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkTilePropertiesQCOM	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkTilePropertiesQCOM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkTilePropertiesQCOM	create()	Returns a new VkTilePropertiesQCOM instance allocated with BufferUtils.
static VkTilePropertiesQCOM.Buffer	create(int capacity)	Returns a new VkTilePropertiesQCOM.Buffer instance allocated with BufferUtils.
static VkTilePropertiesQCOM	create(long address)	Returns a new VkTilePropertiesQCOM instance for the specified memory address.
static VkTilePropertiesQCOM.Buffer	create(long address, int capacity)	Create a VkTilePropertiesQCOM.Buffer instance at the specified memory.
static @Nullable VkTilePropertiesQCOM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkTilePropertiesQCOM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkTilePropertiesQCOM	malloc()	Returns a new VkTilePropertiesQCOM instance allocated with memAlloc.
static VkTilePropertiesQCOM.Buffer	malloc(int capacity)	Returns a new VkTilePropertiesQCOM.Buffer instance allocated with memAlloc.
static VkTilePropertiesQCOM.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkTilePropertiesQCOM.Buffer instance allocated on the specified MemoryStack.
static VkTilePropertiesQCOM	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkTilePropertiesQCOM instance allocated on the specified MemoryStack.
static VkExtent2D	napronSize(long struct)	Unsafe version of apronSize().
static void	napronSize(long struct, VkExtent2D value)	Unsafe version of apronSize.
static VkOffset2D	norigin(long struct)	Unsafe version of origin().
static void	norigin(long struct, VkOffset2D value)	Unsafe version of origin.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static VkExtent3D	ntileSize(long struct)	Unsafe version of tileSize().
static void	ntileSize(long struct, VkExtent3D value)	Unsafe version of tileSize.
VkOffset2D	origin()	the top-left corner of the first tile in attachment space.
VkTilePropertiesQCOM	origin(Consumer<VkOffset2D> consumer)	Passes the origin() field to the specified Consumer.
VkTilePropertiesQCOM	origin(VkOffset2D value)	Copies the specified VkOffset2D to the origin() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkTilePropertiesQCOM	pNext(long value)	Sets the specified value to the pNext() field.
VkTilePropertiesQCOM	set(int sType, long pNext, VkExtent3D tileSize, VkExtent2D apronSize, VkOffset2D origin)	Initializes this struct with the specified values.
VkTilePropertiesQCOM	set(VkTilePropertiesQCOM src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkTilePropertiesQCOM	sType(int value)	Sets the specified value to the sType() field.
VkTilePropertiesQCOM	sType$Default()	Sets the STRUCTURE_TYPE_TILE_PROPERTIES_QCOM value to the sType() field.
VkExtent3D	tileSize()	the dimensions of a tile, with width and height describing the width and height of a tile in pixels, and depth corresponding to the number of slices the tile spans.
VkTilePropertiesQCOM	tileSize(Consumer<VkExtent3D> consumer)	Passes the tileSize() field to the specified Consumer.
VkTilePropertiesQCOM	tileSize(VkExtent3D value)	Copies the specified VkExtent3D to the tileSize() 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.

TILESIZE

public static final int TILESIZE

The struct member offsets.

APRONSIZE

public static final int APRONSIZE

The struct member offsets.

ORIGIN

public static final int ORIGIN

The struct member offsets.

Constructor Details

VkTilePropertiesQCOM

public VkTilePropertiesQCOM(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

tileSize

public VkExtent3D tileSize()

the dimensions of a tile, with width and height describing the width and height of a tile in pixels, and depth corresponding to the number of slices the tile spans.

apronSize

public VkExtent2D apronSize()

the dimension of the apron.

origin

public VkOffset2D origin()

the top-left corner of the first tile in attachment space.

sType

public VkTilePropertiesQCOM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkTilePropertiesQCOM sType$Default()

Sets the STRUCTURE_TYPE_TILE_PROPERTIES_QCOM value to the sType() field.

pNext

public VkTilePropertiesQCOM pNext(long value)

Sets the specified value to the pNext() field.

tileSize

public VkTilePropertiesQCOM tileSize(VkExtent3D value)

Copies the specified VkExtent3D to the tileSize() field.

tileSize

public VkTilePropertiesQCOM tileSize(Consumer<VkExtent3D> consumer)

Passes the tileSize() field to the specified Consumer.

apronSize

public VkTilePropertiesQCOM apronSize(VkExtent2D value)

Copies the specified VkExtent2D to the apronSize() field.

apronSize

public VkTilePropertiesQCOM apronSize(Consumer<VkExtent2D> consumer)

Passes the apronSize() field to the specified Consumer.

origin

public VkTilePropertiesQCOM origin(VkOffset2D value)

Copies the specified VkOffset2D to the origin() field.

origin

public VkTilePropertiesQCOM origin(Consumer<VkOffset2D> consumer)

Passes the origin() field to the specified Consumer.

set

public VkTilePropertiesQCOM set(int sType,
 long pNext,
 VkExtent3D tileSize,
 VkExtent2D apronSize,
 VkOffset2D origin)

Initializes this struct with the specified values.

set

public VkTilePropertiesQCOM set(VkTilePropertiesQCOM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkTilePropertiesQCOM malloc()

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

calloc

public static VkTilePropertiesQCOM calloc()

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

create

public static VkTilePropertiesQCOM create()

Returns a new VkTilePropertiesQCOM instance allocated with BufferUtils.

create

public static VkTilePropertiesQCOM create(long address)

Returns a new VkTilePropertiesQCOM instance for the specified memory address.

createSafe

public static @Nullable VkTilePropertiesQCOM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkTilePropertiesQCOM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkTilePropertiesQCOM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkTilePropertiesQCOM.Buffer create(int capacity)

Returns a new VkTilePropertiesQCOM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkTilePropertiesQCOM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkTilePropertiesQCOM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntileSize

public static VkExtent3D ntileSize(long struct)

Unsafe version of tileSize().

napronSize

public static VkExtent2D napronSize(long struct)

Unsafe version of apronSize().

norigin

public static VkOffset2D norigin(long struct)

Unsafe version of origin().

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.

ntileSize

public static void ntileSize(long struct,
 VkExtent3D value)

Unsafe version of tileSize.

napronSize

public static void napronSize(long struct,
 VkExtent2D value)

Unsafe version of apronSize.

norigin

public static void norigin(long struct,
 VkOffset2D value)

Unsafe version of origin.