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
,NativeResource
,Pointer
- Direct Known Subclasses:
VkPhysicalDeviceSparseImageFormatInfo2KHR
public class VkPhysicalDeviceSparseImageFormatInfo2
extends Struct<VkPhysicalDeviceSparseImageFormatInfo2>
implements NativeResource
Structure specifying sparse image format inputs.
Valid Usage
samples
must be a bit value that is set inVkImageFormatProperties
::sampleCounts
returned byvkGetPhysicalDeviceImageFormatProperties
withformat
,type
,tiling
, andusage
equal to those in this command andflags
equal to the value that is set inVkImageCreateInfo
::flags
when the image is created
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2
pNext
must beNULL
format
must be a validVkFormat
valuetype
must be a validVkImageType
valuesamples
must be a validVkSampleCountFlagBits
valueusage
must be a valid combination ofVkImageUsageFlagBits
valuesusage
must not be 0tiling
must be a validVkImageTiling
value
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
Modifier and TypeClassDescriptionstatic class
An array ofVkPhysicalDeviceSparseImageFormatInfo2
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkPhysicalDeviceSparseImageFormatInfo2
(ByteBuffer container) Creates aVkPhysicalDeviceSparseImageFormatInfo2
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance for the specified memory address.create
(long address, int capacity) Create aVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
format()
the image format.format
(int value) Sets the specified value to theformat()
field.malloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
nformat
(long struct) Unsafe version offormat()
.static void
nformat
(long struct, int value) Unsafe version offormat
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsamples
(long struct) Unsafe version ofsamples()
.static void
nsamples
(long struct, int value) Unsafe version ofsamples
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
ntiling
(long struct) Unsafe version oftiling()
.static void
ntiling
(long struct, int value) Unsafe version oftiling
.static int
ntype
(long struct) Unsafe version oftype()
.static void
ntype
(long struct, int value) Unsafe version oftype
.static int
nusage
(long struct) Unsafe version ofusage()
.static void
nusage
(long struct, int value) Unsafe version ofusage
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.int
samples()
aVkSampleCountFlagBits
value 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.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2
value to thesType()
field.int
tiling()
the tiling arrangement of the texel blocks in memory.tiling
(int value) Sets the specified value to thetiling()
field.int
type()
the dimensionality of image.type
(int value) Sets the specified value to thetype()
field.int
usage()
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.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkPhysicalDeviceSparseImageFormatInfo2
instance at the current position of the specifiedByteBuffer
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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPhysicalDeviceSparseImageFormatInfo2>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
format
public int format()the image format. -
type
public int type()the dimensionality of image. -
samples
public int samples()aVkSampleCountFlagBits
value 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_2
value 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 newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withBufferUtils
. -
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
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, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-