Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkTilePropertiesQCOM

extends Struct<VkTilePropertiesQCOM>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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)
See Also

VkExtent2D, VkExtent3D, VkOffset2D, GetDynamicRenderingTilePropertiesQCOM, GetFramebufferTilePropertiesQCOM

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
APRONSIZE

The struct member offsets.

public static final int
ORIGIN

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
TILESIZE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkTilePropertiesQCOM(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public VkExtent2D
apronSize()

the dimension of the apron.

public VkTilePropertiesQCOM
apronSize(VkExtent2D value)

Copies the specified VkExtent2D to the apronSize field.

public VkTilePropertiesQCOM
apronSize(Consumer<VkExtent2D> consumer)

Passes the apronSize field to the specified Consumer.

public static VkTilePropertiesQCOM
calloc()

Returns a new VkTilePropertiesQCOM instance allocated with memCalloc.

public static VkTilePropertiesQCOM.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkTilePropertiesQCOM.Buffer instance allocated with memCalloc.

public static VkTilePropertiesQCOM
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkTilePropertiesQCOM.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkTilePropertiesQCOM
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

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

Returns a new VkTilePropertiesQCOM instance allocated with BufferUtils.

public static VkTilePropertiesQCOM
create(long address)

Returns a new VkTilePropertiesQCOM instance for the specified memory address.

public static VkTilePropertiesQCOM.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkTilePropertiesQCOM.Buffer instance allocated with BufferUtils.

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

Create a VkTilePropertiesQCOM.Buffer instance at the specified memory.

public static VkTilePropertiesQCOM
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkTilePropertiesQCOM
malloc()

Returns a new VkTilePropertiesQCOM instance allocated with memAlloc.

public static VkTilePropertiesQCOM.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkTilePropertiesQCOM.Buffer instance allocated with memAlloc.

public static VkTilePropertiesQCOM
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkTilePropertiesQCOM instance allocated on the specified MemoryStack.

public static VkTilePropertiesQCOM.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkExtent2D
napronSize(long struct)

Unsafe version of apronSize.

public static void
napronSize(long struct, VkExtent2D value)

Unsafe version of apronSize.

public static VkOffset2D
norigin(long struct)

Unsafe version of origin.

public static void
norigin(long struct, VkOffset2D value)

Unsafe version of origin.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static VkExtent3D
ntileSize(long struct)

Unsafe version of tileSize.

public static void
ntileSize(long struct, VkExtent3D value)

Unsafe version of tileSize.

public VkOffset2D
origin()

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

public VkTilePropertiesQCOM
origin(VkOffset2D value)

Copies the specified VkOffset2D to the origin field.

public VkTilePropertiesQCOM
origin(Consumer<VkOffset2D> consumer)

Passes the origin field to the specified Consumer.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkTilePropertiesQCOM
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkTilePropertiesQCOM

Returns:

this struct
set
(VkTilePropertiesQCOM
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkTilePropertiesQCOM
sType(int value)

Sets the specified value to the sType field.

public VkTilePropertiesQCOM
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.

public VkTilePropertiesQCOM
tileSize(VkExtent3D value)

Copies the specified VkExtent3D to the tileSize field.

public VkTilePropertiesQCOM
tileSize(Consumer<VkExtent3D> consumer)

Passes the tileSize field to the specified Consumer.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

APRONSIZEback to summary
public static final int APRONSIZE

The struct member offsets.

ORIGINback to summary
public static final int ORIGIN

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

TILESIZEback to summary
public static final int TILESIZE

The struct member offsets.

Constructor Detail

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

apronSizeback to summary
public VkExtent2D apronSize()

the dimension of the apron.

apronSizeback to summary
public VkTilePropertiesQCOM apronSize(VkExtent2D value)

Copies the specified VkExtent2D to the apronSize field.

apronSizeback to summary
public VkTilePropertiesQCOM apronSize(Consumer<VkExtent2D> consumer)

Passes the apronSize field to the specified Consumer.

callocback to summary
public static VkTilePropertiesQCOM calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkTilePropertiesQCOM calloc(MemoryStack stack)

Returns a new VkTilePropertiesQCOM 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 VkTilePropertiesQCOM.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkTilePropertiesQCOM.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 VkTilePropertiesQCOM create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.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 VkTilePropertiesQCOM create()

Returns a new VkTilePropertiesQCOM instance allocated with BufferUtils.

createback to summary
public static VkTilePropertiesQCOM create(long address)

Returns a new VkTilePropertiesQCOM instance for the specified memory address.

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

Returns a new VkTilePropertiesQCOM.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkTilePropertiesQCOM.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkTilePropertiesQCOM createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkTilePropertiesQCOM malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkTilePropertiesQCOM malloc(MemoryStack stack)

Returns a new VkTilePropertiesQCOM instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

napronSizeback to summary
public static VkExtent2D napronSize(long struct)

Unsafe version of apronSize.

napronSizeback to summary
public static void napronSize(long struct, VkExtent2D value)

Unsafe version of apronSize.

noriginback to summary
public static VkOffset2D norigin(long struct)

Unsafe version of origin.

noriginback to summary
public static void norigin(long struct, VkOffset2D value)

Unsafe version of origin.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

ntileSizeback to summary
public static VkExtent3D ntileSize(long struct)

Unsafe version of tileSize.

ntileSizeback to summary
public static void ntileSize(long struct, VkExtent3D value)

Unsafe version of tileSize.

originback to summary
public VkOffset2D origin()

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

originback to summary
public VkTilePropertiesQCOM origin(VkOffset2D value)

Copies the specified VkOffset2D to the origin field.

originback to summary
public VkTilePropertiesQCOM origin(Consumer<VkOffset2D> consumer)

Passes the origin field to the specified Consumer.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkTilePropertiesQCOM pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkTilePropertiesQCOM set(VkTilePropertiesQCOM src)

Copies the specified struct data to this struct.

Parameters
src:VkTilePropertiesQCOM

the source struct

Returns:VkTilePropertiesQCOM

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkTilePropertiesQCOM sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkTilePropertiesQCOM sType$Default()

Sets the STRUCTURE_TYPE_TILE_PROPERTIES_QCOM value to the sType field.

tileSizeback to summary
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.

tileSizeback to summary
public VkTilePropertiesQCOM tileSize(VkExtent3D value)

Copies the specified VkExtent3D to the tileSize field.

tileSizeback to summary
public VkTilePropertiesQCOM tileSize(Consumer<VkExtent3D> consumer)

Passes the tileSize field to the specified Consumer.

org.lwjgl.vulkan back to summary

public Class VkTilePropertiesQCOM.Buffer

extends StructBuffer<VkTilePropertiesQCOM, VkTilePropertiesQCOM.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkTilePropertiesQCOM structs.

Field Summary

Modifier and TypeField and Description
private static final VkTilePropertiesQCOM

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkTilePropertiesQCOM.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 VkExtent2D

Returns:

a VkExtent2D view of the VkTilePropertiesQCOM#apronSize field.
apronSize
()

public VkTilePropertiesQCOM.Buffer
apronSize(VkExtent2D value)

Copies the specified VkExtent2D to the VkTilePropertiesQCOM#apronSize field.

public VkTilePropertiesQCOM.Buffer
apronSize(Consumer<VkExtent2D> consumer)

Passes the VkTilePropertiesQCOM#apronSize field to the specified Consumer.

protected VkTilePropertiesQCOM
public VkOffset2D

Returns:

a VkOffset2D view of the VkTilePropertiesQCOM#origin field.
origin
()

public VkTilePropertiesQCOM.Buffer
origin(VkOffset2D value)

Copies the specified VkOffset2D to the VkTilePropertiesQCOM#origin field.

public VkTilePropertiesQCOM.Buffer
origin(Consumer<VkOffset2D> consumer)

Passes the VkTilePropertiesQCOM#origin field to the specified Consumer.

public long

Returns:

the value of the VkTilePropertiesQCOM#pNext field.
pNext
()

public VkTilePropertiesQCOM.Buffer
pNext(long value)

Sets the specified value to the VkTilePropertiesQCOM#pNext field.

protected VkTilePropertiesQCOM.Buffer
public int

Returns:

the value of the VkTilePropertiesQCOM#sType field.
sType
()

public VkTilePropertiesQCOM.Buffer
sType(int value)

Sets the specified value to the VkTilePropertiesQCOM#sType field.

public VkTilePropertiesQCOM.Buffer
public VkExtent3D

Returns:

a VkExtent3D view of the VkTilePropertiesQCOM#tileSize field.
tileSize
()

public VkTilePropertiesQCOM.Buffer
tileSize(VkExtent3D value)

Copies the specified VkExtent3D to the VkTilePropertiesQCOM#tileSize field.

public VkTilePropertiesQCOM.Buffer
tileSize(Consumer<VkExtent3D> consumer)

Passes the VkTilePropertiesQCOM#tileSize field to the specified Consumer.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkTilePropertiesQCOM ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkTilePropertiesQCOM.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 VkTilePropertiesQCOM#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

apronSizeback to summary
public VkExtent2D apronSize()
Returns:VkExtent2D

a VkExtent2D view of the VkTilePropertiesQCOM#apronSize field.

apronSizeback to summary
public VkTilePropertiesQCOM.Buffer apronSize(VkExtent2D value)

Copies the specified VkExtent2D to the VkTilePropertiesQCOM#apronSize field.

apronSizeback to summary
public VkTilePropertiesQCOM.Buffer apronSize(Consumer<VkExtent2D> consumer)

Passes the VkTilePropertiesQCOM#apronSize field to the specified Consumer.

getElementFactoryback to summary
protected VkTilePropertiesQCOM getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
originback to summary
public VkOffset2D origin()
Returns:VkOffset2D

a VkOffset2D view of the VkTilePropertiesQCOM#origin field.

originback to summary
public VkTilePropertiesQCOM.Buffer origin(VkOffset2D value)

Copies the specified VkOffset2D to the VkTilePropertiesQCOM#origin field.

originback to summary
public VkTilePropertiesQCOM.Buffer origin(Consumer<VkOffset2D> consumer)

Passes the VkTilePropertiesQCOM#origin field to the specified Consumer.

pNextback to summary
public long pNext()
Returns:long

the value of the VkTilePropertiesQCOM#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkTilePropertiesQCOM.Buffer pNext(long value)

Sets the specified value to the VkTilePropertiesQCOM#pNext field.

selfback to summary
protected VkTilePropertiesQCOM.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkTilePropertiesQCOM#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkTilePropertiesQCOM.Buffer sType(int value)

Sets the specified value to the VkTilePropertiesQCOM#sType field.

sType$Defaultback to summary
public VkTilePropertiesQCOM.Buffer sType$Default()

Sets the STRUCTURE_TYPE_TILE_PROPERTIES_QCOM value to the VkTilePropertiesQCOM#sType field.

tileSizeback to summary
public VkExtent3D tileSize()
Returns:VkExtent3D

a VkExtent3D view of the VkTilePropertiesQCOM#tileSize field.

tileSizeback to summary
public VkTilePropertiesQCOM.Buffer tileSize(VkExtent3D value)

Copies the specified VkExtent3D to the VkTilePropertiesQCOM#tileSize field.

tileSizeback to summary
public VkTilePropertiesQCOM.Buffer tileSize(Consumer<VkExtent3D> consumer)

Passes the VkTilePropertiesQCOM#tileSize field to the specified Consumer.