VkPhysicalDeviceSparseImageFormatInfo2 (LWJGL 3.2.4 SNAPSHOT

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

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 in VkSampleCountFlagBits.
- 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 and 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
Modifier and Type	Class and Description
`static class`	`VkPhysicalDeviceSparseImageFormatInfo2.Buffer` An array of `VkPhysicalDeviceSparseImageFormatInfo2` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FORMAT` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SAMPLES` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`TILING` The struct member offsets.
`static int`	`TYPE` The struct member offsets.
`static int`	`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 and 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
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`callocStack(int capacity)` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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()` Returns the value of the `format` field.
`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`	`mallocStack()` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`mallocStack(int capacity)` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceSparseImageFormatInfo2.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceSparseImageFormatInfo2`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceSparseImageFormatInfo2` instance allocated on the specified `MemoryStack`.
`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()` Returns the value of the `pNext` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`samples()` Returns the value of the `samples` field.
`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()` Returns the value of the `sType` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`tiling()` Returns the value of the `tiling` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`tiling(int value)` Sets the specified value to the `tiling` field.
`int`	`type()` Returns the value of the `type` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`type(int value)` Sets the specified value to the `type` field.
`int`	`usage()` Returns the value of the `usage` field.
`VkPhysicalDeviceSparseImageFormatInfo2`	`usage(int value)` Sets the specified value to the `usage` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FORMAT
```
public static final int FORMAT
```
    The struct member offsets.
  - TYPE
```
public static final int TYPE
```
    The struct member offsets.
  - SAMPLES
```
public static final int SAMPLES
```
    The struct member offsets.
  - USAGE
```
public static final int USAGE
```
    The struct member offsets.
  - TILING
```
public static final int 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - format
```
public int format()
```
    Returns the value of the format field.
  - type
```
public int type()
```
    Returns the value of the type field.
  - samples
```
public int samples()
```
    Returns the value of the samples field.
  - usage
```
public int usage()
```
    Returns the value of the usage field.
  - tiling
```
public int tiling()
```
    Returns the value of the tiling field.
  - sType
```
public VkPhysicalDeviceSparseImageFormatInfo2 sType(int value)
```
    Sets the specified 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
```
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack()
```
    Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack()
```
    Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2 mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceSparseImageFormatInfo2 instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2 callocStack(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
  - mallocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer mallocStack(int capacity)
```
    Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(int capacity)
```
    Returns a new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the thread-local MemoryStack 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 new VkPhysicalDeviceSparseImageFormatInfo2.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceSparseImageFormatInfo2.Buffer callocStack(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

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

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

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

nsType

npNext

nformat

ntype

nsamples

nusage

ntiling

nsType

npNext

nformat

ntype

nsamples

nusage

ntiling