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 in VkImageFormatProperties::sampleCounts returned by vkGetPhysicalDeviceImageFormatProperties with format, type, tiling, and usage equal to those in this command and flags equal to the value that is set in VkImageCreateInfo::flags when the image is created
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2
- pNext must be NULL
- format must be a valid VkFormat value
- type must be a valid VkImageType value
- samples must be a valid VkSampleCountFlagBits value
- usage must be a valid combination of VkImageUsageFlagBits values
- usage must not be 0
- tiling must be a valid VkImageTiling 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

Nested Classes
Modifier and Type Class Description

static class VkPhysicalDeviceSparseImageFormatInfo2.Buffer
An array of VkPhysicalDeviceSparseImageFormatInfo2 structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FORMAT PNEXT SAMPLES`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE TILING TYPE USAGE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkPhysicalDeviceSparseImageFormatInfo2(java.nio.ByteBuffer container)`	Creates a `VkPhysicalDeviceSparseImageFormatInfo2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static VkPhysicalDeviceSparseImageFormatInfo2`	`calloc()`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `memCalloc`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`calloc(int capacity)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `memCalloc`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`callocStack()`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`callocStack(int capacity)`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`callocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`create()`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`create(int capacity)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`create(long address)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance for the specified memory address.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`create(long address, int capacity)`	Create a `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance at the specified memory.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`format()`	the image format.
`VkPhysicalDeviceSparseImageFormatInfo2`	`format(int value)`	Sets the specified value to the `format()` field.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`malloc()`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated with `memAlloc`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`malloc(int capacity)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated with `memAlloc`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`mallocStack()`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`mallocStack(int capacity)`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`mallocStack(org.lwjgl.system.MemoryStack stack)`	Deprecated.
`static int`	`nformat(long struct)`	Unsafe version of `format()`.
`static void`	`nformat(long struct, int value)`	Unsafe version of `format`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsamples(long struct)`	Unsafe version of `samples()`.
`static void`	`nsamples(long struct, int value)`	Unsafe version of `samples`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static int`	`ntiling(long struct)`	Unsafe version of `tiling()`.
`static void`	`ntiling(long struct, int value)`	Unsafe version of `tiling`.
`static int`	`ntype(long struct)`	Unsafe version of `type()`.
`static void`	`ntype(long struct, int value)`	Unsafe version of `type`.
`static int`	`nusage(long struct)`	Unsafe version of `usage()`.
`static void`	`nusage(long struct, int value)`	Unsafe version of `usage`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkPhysicalDeviceSparseImageFormatInfo2`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`int`	`samples()`	a `VkSampleCountFlagBits` value specifying the number of samples per texel.
`VkPhysicalDeviceSparseImageFormatInfo2`	`samples(int value)`	Sets the specified value to the `samples()` 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()`	the type of this structure.
`VkPhysicalDeviceSparseImageFormatInfo2`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`sType$Default()`	Sets the `STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2` value to the `sType()` field.
`int`	`tiling()`	the tiling arrangement of the texel blocks in memory.
`VkPhysicalDeviceSparseImageFormatInfo2`	`tiling(int value)`	Sets the specified value to the `tiling()` field.
`int`	`type()`	the dimensionality of image.
`VkPhysicalDeviceSparseImageFormatInfo2`	`type(int value)`	Sets the specified value to the `type()` field.
`int`	`usage()`	a bitmask describing the intended usage of the image.
`VkPhysicalDeviceSparseImageFormatInfo2`	`usage(int value)`	Sets the specified value to the `usage()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, FORMAT, TYPE, SAMPLES, USAGE, TILING
  
  The struct member offsets.

Constructor Detail
- VkPhysicalDeviceSparseImageFormatInfo2
```
public VkPhysicalDeviceSparseImageFormatInfo2(java.nio.ByteBuffer container)
```
  Creates a VkPhysicalDeviceSparseImageFormatInfo2 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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of 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()
```
a VkSampleCountFlagBits 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

public VkPhysicalDeviceSparseImageFormatInfo2 sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkPhysicalDeviceSparseImageFormatInfo2 sType$Default()
```
Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SPARSE_IMAGE_FORMAT_INFO_2 value to the sType() field.

pNext

public VkPhysicalDeviceSparseImageFormatInfo2 pNext(long value)

Sets the specified value to the pNext() field.

format

public VkPhysicalDeviceSparseImageFormatInfo2 format(int value)

Sets the specified value to the format() field.

type

public VkPhysicalDeviceSparseImageFormatInfo2 type(int value)

Sets the specified value to the type() field.

samples

public VkPhysicalDeviceSparseImageFormatInfo2 samples(int value)

Sets the specified value to the samples() field.

usage

public VkPhysicalDeviceSparseImageFormatInfo2 usage(int value)

Sets the specified value to the usage() field.

tiling

public VkPhysicalDeviceSparseImageFormatInfo2 tiling(int value)

Sets the specified value to the tiling() 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 new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2 calloc()
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPhysicalDeviceSparseImageFormatInfo2 create()
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated with BufferUtils.

create
```
public static VkPhysicalDeviceSparseImageFormatInfo2 create(long address)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance for the specified memory address.

createSafe

@Nullable
public static VkPhysicalDeviceSparseImageFormatInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer malloc(int capacity)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(int capacity)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer create(long address,
                                                                   int capacity)

Create a VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

@Nullable
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer createSafe(long address,
                                                                       int capacity)

Like create, but returns null if address is NULL.

mallocStack
```
@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack()
```
Deprecated.

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

callocStack
```
@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack()
```
Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(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. Use malloc(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. Use calloc(int, MemoryStack) instead.

malloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2 malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2 calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack and 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 new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer calloc(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nformat

public static int nformat(long struct)

Unsafe version of format().

ntype

public static int ntype(long struct)

Unsafe version of type().

nsamples

public static int nsamples(long struct)

Unsafe version of samples().

nusage

public static int nusage(long struct)

Unsafe version of usage().

ntiling

public static int ntiling(long struct)

Unsafe version of tiling().

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nformat

public static void nformat(long struct,
                           int value)

Unsafe version of format.

ntype

public static void ntype(long struct,
                         int value)

Unsafe version of type.

nsamples

public static void nsamples(long struct,
                            int value)

Unsafe version of samples.

nusage

public static void nusage(long struct,
                          int value)

Unsafe version of usage.

ntiling

public static void ntiling(long struct,
                           int value)

Unsafe version of tiling.

Class VkPhysicalDeviceSparseImageFormatInfo2

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FORMAT, TYPE, SAMPLES, USAGE, TILING

Constructor Detail

VkPhysicalDeviceSparseImageFormatInfo2

Method Detail

sizeof

sType

pNext

format

type

samples

usage

tiling

sType

sType$Default

pNext

format

type

samples

usage

tiling

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nformat

ntype

nsamples

nusage

ntiling

nsType

npNext

nformat

ntype

nsamples

nusage

ntiling