Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSparseImageFormatProperties2

extends Struct<VkSparseImageFormatProperties2>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSparseImageFormatProperties2KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying sparse image format properties.
Valid Usage (Implicit)
See Also

VkSparseImageFormatProperties, GetPhysicalDeviceSparseImageFormatProperties2, GetPhysicalDeviceSparseImageFormatProperties2KHR

Layout


struct VkSparseImageFormatProperties2 {
    VkStructureType sType;
    void * pNext;
    VkSparseImageFormatProperties properties;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSparseImageFormatProperties2.Buffer

An array of VkSparseImageFormatProperties2 structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PROPERTIES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkSparseImageFormatProperties2(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSparseImageFormatProperties2
calloc()

Returns a new VkSparseImageFormatProperties2 instance allocated with memCalloc.

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

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSparseImageFormatProperties2
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSparseImageFormatProperties2
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 VkSparseImageFormatProperties2
create()

Returns a new VkSparseImageFormatProperties2 instance allocated with BufferUtils.

public static VkSparseImageFormatProperties2
create(long address)

Returns a new VkSparseImageFormatProperties2 instance for the specified memory address.

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

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with BufferUtils.

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

Create a VkSparseImageFormatProperties2.Buffer instance at the specified memory.

public static VkSparseImageFormatProperties2
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSparseImageFormatProperties2
malloc()

Returns a new VkSparseImageFormatProperties2 instance allocated with memAlloc.

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

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memAlloc.

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

Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack.

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

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

public static VkSparseImageFormatProperties2
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageFormatProperties2.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkSparseImageFormatProperties
nproperties(long struct)

Unsafe version of properties.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSparseImageFormatProperties2
pNext(long value)

Sets the specified value to the pNext field.

public VkSparseImageFormatProperties
properties()

a VkSparseImageFormatProperties structure which is populated with the same values as in GetPhysicalDeviceSparseImageFormatProperties.

public VkSparseImageFormatProperties2
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkSparseImageFormatProperties2

Returns:

this struct
set(VkSparseImageFormatProperties2
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 VkSparseImageFormatProperties2
sType(int value)

Sets the specified value to the sType field.

public VkSparseImageFormatProperties2
sType$Default()

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.

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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PROPERTIESback to summary
public static final int PROPERTIES

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.

Constructor Detail

VkSparseImageFormatProperties2back to summary
protected VkSparseImageFormatProperties2(long address, ByteBuffer container)
VkSparseImageFormatProperties2back to summary
public VkSparseImageFormatProperties2(ByteBuffer container)

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

callocback to summary
public static VkSparseImageFormatProperties2 calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSparseImageFormatProperties2 calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkSparseImageFormatProperties2 callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageFormatProperties2 callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageFormatProperties2.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageFormatProperties2.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkSparseImageFormatProperties2 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 VkSparseImageFormatProperties2 create()

Returns a new VkSparseImageFormatProperties2 instance allocated with BufferUtils.

createback to summary
public static VkSparseImageFormatProperties2 create(long address)

Returns a new VkSparseImageFormatProperties2 instance for the specified memory address.

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

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSparseImageFormatProperties2.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSparseImageFormatProperties2 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSparseImageFormatProperties2 malloc(MemoryStack stack)

Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSparseImageFormatProperties2 mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageFormatProperties2 mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageFormatProperties2.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageFormatProperties2.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
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.

npropertiesback to summary
public static VkSparseImageFormatProperties nproperties(long struct)

Unsafe version of properties.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

propertiesback to summary
public VkSparseImageFormatProperties properties()

a VkSparseImageFormatProperties structure which is populated with the same values as in GetPhysicalDeviceSparseImageFormatProperties.

setback to summary
public VkSparseImageFormatProperties2 set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkSparseImageFormatProperties2 set(VkSparseImageFormatProperties2 src)

Copies the specified struct data to this struct.

Parameters
src:VkSparseImageFormatProperties2

the source struct

Returns:VkSparseImageFormatProperties2

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 VkSparseImageFormatProperties2 sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSparseImageFormatProperties2.Buffer

extends StructBuffer<VkSparseImageFormatProperties2, VkSparseImageFormatProperties2.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSparseImageFormatProperties2KHR.Buffer
An array of VkSparseImageFormatProperties2 structs.

Field Summary

Modifier and TypeField and Description
private static final VkSparseImageFormatProperties2
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSparseImageFormatProperties2.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
protected VkSparseImageFormatProperties2
getElementFactory()

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

public long

Returns:

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

public VkSparseImageFormatProperties2.Buffer
pNext(long value)

Sets the specified value to the VkSparseImageFormatProperties2#pNext field.

public VkSparseImageFormatProperties

Returns:

a VkSparseImageFormatProperties view of the VkSparseImageFormatProperties2#properties field.
properties()

protected VkSparseImageFormatProperties2.Buffer
self()

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

public int

Returns:

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

public VkSparseImageFormatProperties2.Buffer
sType(int value)

Sets the specified value to the VkSparseImageFormatProperties2#sType field.

public VkSparseImageFormatProperties2.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the VkSparseImageFormatProperties2#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSparseImageFormatProperties2 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkSparseImageFormatProperties2 getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSparseImageFormatProperties2#pNext field.

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

Sets the specified value to the VkSparseImageFormatProperties2#pNext field.

propertiesback to summary
public VkSparseImageFormatProperties properties()
Returns:VkSparseImageFormatProperties

a VkSparseImageFormatProperties view of the VkSparseImageFormatProperties2#properties field.

selfback to summary
protected VkSparseImageFormatProperties2.Buffer self()

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

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

the value of the VkSparseImageFormatProperties2#sType field.

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

Sets the specified value to the VkSparseImageFormatProperties2#sType field.

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

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the VkSparseImageFormatProperties2#sType field.