Package org.lwjgl.vulkan
Class VkPhysicalDeviceSparseImageFormatInfo2
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceSparseImageFormatInfo2>
org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPhysicalDeviceSparseImageFormatInfo2KHR
public class VkPhysicalDeviceSparseImageFormatInfo2
extends org.lwjgl.system.Struct<VkPhysicalDeviceSparseImageFormatInfo2>
implements org.lwjgl.system.NativeResource
Structure specifying sparse image format inputs.
Valid Usage
samplesmust be a validVkSampleCountFlagBitsvalue that is set inVkImageFormatProperties::sampleCountsreturned byvkGetPhysicalDeviceImageFormatPropertieswithformat,type,tiling, andusageequal to those in this command
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2pNextmust beNULLformatmust be a validVkFormatvaluetypemust be a validVkImageTypevaluesamplesmust be a validVkSampleCountFlagBitsvalueusagemust be a valid combination ofVkImageUsageFlagBitsvaluesusagemust not be 0tilingmust be a validVkImageTilingvalue
See Also
GetPhysicalDeviceSparseImageFormatProperties2, GetPhysicalDeviceSparseImageFormatProperties2KHR
Layout
struct VkPhysicalDeviceSparseImageFormatInfo2 {
VkStructureType sType();
void const * pNext();
VkFormat format();
VkImageType type();
VkSampleCountFlagBits samples();
VkImageUsageFlags usage();
VkImageTiling tiling();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPhysicalDeviceSparseImageFormatInfo2structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkPhysicalDeviceSparseImageFormatInfo2(ByteBuffer container) Creates aVkPhysicalDeviceSparseImageFormatInfo2instance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withmemCalloc.calloc(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withBufferUtils.create(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance for the specified memory address.create(long address, int capacity) Create aVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance at the specified memory.static @Nullable VkPhysicalDeviceSparseImageFormatInfo2createSafe(long address) static @Nullable VkPhysicalDeviceSparseImageFormatInfo2.BuffercreateSafe(long address, int capacity) intformat()the image format.format(int value) Sets the specified value to theformat()field.malloc()Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withmemAlloc.malloc(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnformat(long struct) Unsafe version offormat().static voidnformat(long struct, int value) Unsafe version offormat.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsamples(long struct) Unsafe version ofsamples().static voidnsamples(long struct, int value) Unsafe version ofsamples.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntiling(long struct) Unsafe version oftiling().static voidntiling(long struct, int value) Unsafe version oftiling.static intntype(long struct) Unsafe version oftype().static voidntype(long struct, int value) Unsafe version oftype.static intnusage(long struct) Unsafe version ofusage().static voidnusage(long struct, int value) Unsafe version ofusage.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.intsamples()aVkSampleCountFlagBitsvalue specifying the number of samples per texel.samples(int value) Sets the specified value to thesamples()field.set(int sType, long pNext, int format, int type, int samples, int usage, int tiling) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2value to thesType()field.inttiling()the tiling arrangement of the texel blocks in memory.tiling(int value) Sets the specified value to thetiling()field.inttype()the dimensionality of the image.type(int value) Sets the specified value to thetype()field.intusage()a bitmask describing the intended usage of the image.usage(int value) Sets the specified value to theusage()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FORMAT
public static final int FORMATThe struct member offsets. -
TYPE
public static final int TYPEThe struct member offsets. -
SAMPLES
public static final int SAMPLESThe struct member offsets. -
USAGE
public static final int USAGEThe struct member offsets. -
TILING
public static final int TILINGThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceSparseImageFormatInfo2
Creates aVkPhysicalDeviceSparseImageFormatInfo2instance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkPhysicalDeviceSparseImageFormatInfo2>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
format
public int format()the image format. -
type
public int type()the dimensionality of the image. -
samples
public int samples()aVkSampleCountFlagBitsvalue specifying the number of samples per texel. -
usage
public int usage()a bitmask describing the intended usage of the image. -
tiling
public int tiling()the tiling arrangement of the texel blocks in memory. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2value to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
format
Sets the specified value to theformat()field. -
type
Sets the specified value to thetype()field. -
samples
Sets the specified value to thesamples()field. -
usage
Sets the specified value to theusage()field. -
tiling
Sets the specified value to thetiling()field. -
set
public VkPhysicalDeviceSparseImageFormatInfo2 set(int sType, long pNext, int format, int type, int samples, int usage, int tiling) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated withBufferUtils. -
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPhysicalDeviceSparseImageFormatInfo2.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nformat
public static int nformat(long struct) Unsafe version offormat(). -
ntype
public static int ntype(long struct) Unsafe version oftype(). -
nsamples
public static int nsamples(long struct) Unsafe version ofsamples(). -
nusage
public static int nusage(long struct) Unsafe version ofusage(). -
ntiling
public static int ntiling(long struct) Unsafe version oftiling(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nformat
public static void nformat(long struct, int value) Unsafe version offormat. -
ntype
public static void ntype(long struct, int value) Unsafe version oftype. -
nsamples
public static void nsamples(long struct, int value) Unsafe version ofsamples. -
nusage
public static void nusage(long struct, int value) Unsafe version ofusage. -
ntiling
public static void ntiling(long struct, int value) Unsafe version oftiling.
-