Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSparseImageFormatProperties2KHR

extends VkSparseImageFormatProperties2
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
See VkSparseImageFormatProperties2.

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSparseImageFormatProperties2KHR.Buffer

An array of VkSparseImageFormatProperties2KHR structs.

Field Summary

Inherited from org.lwjgl.vulkan.VkSparseImageFormatProperties2:
ALIGNOFPNEXTPROPERTIESSIZEOFSTYPE

Constructor Summary

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

public
VkSparseImageFormatProperties2KHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSparseImageFormatProperties2KHR
calloc()

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

Returns a new VkSparseImageFormatProperties2KHR instance allocated with memCalloc.
public static VkSparseImageFormatProperties2KHR.Buffer
calloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated with memCalloc.
public static VkSparseImageFormatProperties2KHR
calloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

Returns a new VkSparseImageFormatProperties2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkSparseImageFormatProperties2KHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkSparseImageFormatProperties2KHR
callocStack()

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

Deprecated
Deprecated for removal in 3.4.0.
protected VkSparseImageFormatProperties2KHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR instance allocated with BufferUtils.
public static VkSparseImageFormatProperties2KHR
create(long address)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR instance for the specified memory address.
public static VkSparseImageFormatProperties2KHR.Buffer
create(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated with BufferUtils.
public static VkSparseImageFormatProperties2KHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Create a VkSparseImageFormatProperties2KHR.Buffer instance at the specified memory.
public static VkSparseImageFormatProperties2KHR
createSafe(long address)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.createSafe.

Like create, but returns null if address is NULL.
public static VkSparseImageFormatProperties2KHR.Buffer
createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.createSafe.

Like create, but returns null if address is NULL.
public static VkSparseImageFormatProperties2KHR
malloc()

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

Returns a new VkSparseImageFormatProperties2KHR instance allocated with memAlloc.
public static VkSparseImageFormatProperties2KHR.Buffer
malloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated with memAlloc.
public static VkSparseImageFormatProperties2KHR
malloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

Returns a new VkSparseImageFormatProperties2KHR instance allocated on the specified MemoryStack.
public static VkSparseImageFormatProperties2KHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated on the specified MemoryStack.
public static VkSparseImageFormatProperties2KHR
mallocStack()

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

Deprecated
Deprecated for removal in 3.4.0.
public VkSparseImageFormatProperties2KHR
pNext(long value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.pNext.

Sets the specified value to the pNext field.
public VkSparseImageFormatProperties2KHR
set(int sType, long pNext)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.set.

Initializes this struct with the specified values.
public VkSparseImageFormatProperties2KHR

Returns:

this struct
set(VkSparseImageFormatProperties2KHR
the source struct
src)

Copies the specified struct data to this struct.

public VkSparseImageFormatProperties2KHR
sType(int value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.sType.

Sets the specified value to the sType field.
public VkSparseImageFormatProperties2KHR
sType$Default()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.sType$Default.

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkSparseImageFormatProperties2:
npNextnpNextnpropertiesnsTypensTypepNextpropertiessetsizeofsType

Constructor Detail

VkSparseImageFormatProperties2KHRback to summary
protected VkSparseImageFormatProperties2KHR(long address, ByteBuffer container)
VkSparseImageFormatProperties2KHRback to summary
public VkSparseImageFormatProperties2KHR(ByteBuffer container)

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSparseImageFormatProperties2KHR calloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.calloc.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.callocStack.

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkSparseImageFormatProperties2KHR create(long address, ByteBuffer container)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.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 VkSparseImageFormatProperties2KHR create()

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR instance allocated with BufferUtils.

createback to summary
public static VkSparseImageFormatProperties2KHR create(long address)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR instance for the specified memory address.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Returns a new VkSparseImageFormatProperties2KHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.create.

Create a VkSparseImageFormatProperties2KHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSparseImageFormatProperties2KHR createSafe(long address)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.createSafe.

Like create, but returns null if address is NULL.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.createSafe.

Like create, but returns null if address is NULL.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSparseImageFormatProperties2KHR malloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

Returns a new VkSparseImageFormatProperties2KHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.malloc.

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

Deprecated

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

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

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.mallocStack.

Deprecated

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

Annotations
@Deprecated
pNextback to summary
public VkSparseImageFormatProperties2KHR pNext(long value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
setback to summary
public VkSparseImageFormatProperties2KHR set(int sType, long pNext)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.set.

Initializes this struct with the specified values.

Annotations
@Override
setback to summary
public VkSparseImageFormatProperties2KHR set(VkSparseImageFormatProperties2KHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSparseImageFormatProperties2KHR

the source struct

Returns:VkSparseImageFormatProperties2KHR

this struct

sTypeback to summary
public VkSparseImageFormatProperties2KHR sType(int value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkSparseImageFormatProperties2KHR sType$Default()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.sType$Default.

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkSparseImageFormatProperties2KHR.Buffer

extends Buffer
Class Inheritance
An array of VkSparseImageFormatProperties2KHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSparseImageFormatProperties2KHR
ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.ELEMENT_FACTORY.

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.getElementFactory.

public VkSparseImageFormatProperties2KHR.Buffer
pNext(long value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.pNext.

Sets the specified value to the pNext field.
protected VkSparseImageFormatProperties2KHR.Buffer
self()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.self.

public VkSparseImageFormatProperties2KHR.Buffer
sType(int value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.sType.

Sets the specified value to the sType field.
public VkSparseImageFormatProperties2KHR.Buffer
sType$Default()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.
Inherited from org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer:
pNextpropertiessType

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSparseImageFormatProperties2KHR ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.ELEMENT_FACTORY.

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSparseImageFormatProperties2KHR.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 VkSparseImageFormatProperties2KHR#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 VkSparseImageFormatProperties2KHR getElementFactory()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.getElementFactory.

Annotations
@Override
pNextback to summary
public VkSparseImageFormatProperties2KHR.Buffer pNext(long value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
selfback to summary
protected VkSparseImageFormatProperties2KHR.Buffer self()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.self.

Annotations
@Override
sTypeback to summary
public VkSparseImageFormatProperties2KHR.Buffer sType(int value)

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkSparseImageFormatProperties2KHR.Buffer sType$Default()

Overrides org.lwjgl.vulkan.VkSparseImageFormatProperties2.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType field.

Annotations
@Override