Package org.lwjgl.vulkan
Class VkPhysicalDeviceSparseImageFormatInfo2
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceSparseImageFormatInfo2
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkPhysicalDeviceSparseImageFormatInfo2KHR
public class VkPhysicalDeviceSparseImageFormatInfo2 extends org.lwjgl.system.Struct implements org.lwjgl.system.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
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.format
– the image format.type
– the dimensionality of image.samples
– the number of samples per texel as defined inVkSampleCountFlagBits
.usage
– a bitmask describing the intended usage of the image.tiling
– the tiling arrangement of the texel blocks in memory.
Layout
struct VkPhysicalDeviceSparseImageFormatInfo2 { VkStructureType sType; void const * pNext; VkFormat format; VkImageType type; VkSampleCountFlagBits samples; VkImageUsageFlags usage; VkImageTiling tiling; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPhysicalDeviceSparseImageFormatInfo2.Buffer
An array ofVkPhysicalDeviceSparseImageFormatInfo2
structs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceSparseImageFormatInfo2(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceSparseImageFormatInfo2
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceSparseImageFormatInfo2
calloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemCalloc
.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceSparseImageFormatInfo2
callocStack()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSparseImageFormatInfo2
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSparseImageFormatInfo2
create()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withBufferUtils
.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceSparseImageFormatInfo2
create(long address)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance for the specified memory address.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance at the specified memory.static VkPhysicalDeviceSparseImageFormatInfo2
createSafe(long address)
static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
createSafe(long address, int capacity)
int
format()
Returns the value of theformat
field.VkPhysicalDeviceSparseImageFormatInfo2
format(int value)
Sets the specified value to theformat
field.static VkPhysicalDeviceSparseImageFormatInfo2
malloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemAlloc
.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceSparseImageFormatInfo2
mallocStack()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceSparseImageFormatInfo2.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceSparseImageFormatInfo2
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
.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()
Returns the value of thepNext
field.VkPhysicalDeviceSparseImageFormatInfo2
pNext(long value)
Sets the specified value to thepNext
field.int
samples()
Returns the value of thesamples
field.VkPhysicalDeviceSparseImageFormatInfo2
samples(int value)
Sets the specified value to thesamples
field.VkPhysicalDeviceSparseImageFormatInfo2
set(int sType, long pNext, int format, int type, int samples, int usage, int tiling)
Initializes this struct with the specified values.VkPhysicalDeviceSparseImageFormatInfo2
set(VkPhysicalDeviceSparseImageFormatInfo2 src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPhysicalDeviceSparseImageFormatInfo2
sType(int value)
Sets the specified value to thesType
field.int
tiling()
Returns the value of thetiling
field.VkPhysicalDeviceSparseImageFormatInfo2
tiling(int value)
Sets the specified value to thetiling
field.int
type()
Returns the value of thetype
field.VkPhysicalDeviceSparseImageFormatInfo2
type(int value)
Sets the specified value to thetype
field.int
usage()
Returns the value of theusage
field.VkPhysicalDeviceSparseImageFormatInfo2
usage(int value)
Sets the specified value to theusage
field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceSparseImageFormatInfo2
public VkPhysicalDeviceSparseImageFormatInfo2(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
format
public int format()
Returns the value of theformat
field.
-
type
public int type()
Returns the value of thetype
field.
-
samples
public int samples()
Returns the value of thesamples
field.
-
usage
public int usage()
Returns the value of theusage
field.
-
tiling
public int tiling()
Returns the value of thetiling
field.
-
sType
public VkPhysicalDeviceSparseImageFormatInfo2 sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPhysicalDeviceSparseImageFormatInfo2 pNext(long value)
Sets the specified value to thepNext
field.
-
format
public VkPhysicalDeviceSparseImageFormatInfo2 format(int value)
Sets the specified value to theformat
field.
-
type
public VkPhysicalDeviceSparseImageFormatInfo2 type(int value)
Sets the specified value to thetype
field.
-
samples
public VkPhysicalDeviceSparseImageFormatInfo2 samples(int value)
Sets the specified value to thesamples
field.
-
usage
public VkPhysicalDeviceSparseImageFormatInfo2 usage(int value)
Sets the specified value to theusage
field.
-
tiling
public VkPhysicalDeviceSparseImageFormatInfo2 tiling(int value)
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
public VkPhysicalDeviceSparseImageFormatInfo2 set(VkPhysicalDeviceSparseImageFormatInfo2 src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceSparseImageFormatInfo2 malloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceSparseImageFormatInfo2 calloc()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceSparseImageFormatInfo2 create()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceSparseImageFormatInfo2 create(long address)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceSparseImageFormatInfo2 createSafe(long address)
-
malloc
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(long address, int capacity)
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
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack()
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSparseImageFormatInfo2.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
.
-
-