VkSparseImageFormatProperties (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSparseImageFormatProperties

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSparseImageFormatProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying sparse image format properties.
Member documentation
- aspectMask – a bitmask VkImageAspectFlagBits specifying which aspects of the image the properties apply to.
- imageGranularity – the width, height, and depth of the sparse image block in texels or compressed texel blocks.
- flags – a bitmask of VkSparseImageFormatFlagBits specifying additional information about the sparse resource.
Layout
```
 struct VkSparseImageFormatProperties {
     VkImageAspectFlags aspectMask;
     VkExtent3D imageGranularity;
     VkSparseImageFormatFlags flags;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkSparseImageFormatProperties.Buffer
An array of VkSparseImageFormatProperties 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`	`VkSparseImageFormatProperties.Buffer` An array of `VkSparseImageFormatProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ASPECTMASK` The struct member offsets.
`static int`	`FLAGS` The struct member offsets.
`static int`	`IMAGEGRANULARITY` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description
`VkSparseImageFormatProperties(java.nio.ByteBuffer container)` Creates a `VkSparseImageFormatProperties` 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
`int`	`aspectMask()` Returns the value of the `aspectMask` field.
`static VkSparseImageFormatProperties`	`calloc()` Returns a new `VkSparseImageFormatProperties` instance allocated with `memCalloc`.
`static VkSparseImageFormatProperties.Buffer`	`calloc(int capacity)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `memCalloc`.
`static VkSparseImageFormatProperties`	`callocStack()` Returns a new `VkSparseImageFormatProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageFormatProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageFormatProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageFormatProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageFormatProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSparseImageFormatProperties`	`create()` Returns a new `VkSparseImageFormatProperties` instance allocated with `BufferUtils`.
`static VkSparseImageFormatProperties.Buffer`	`create(int capacity)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `BufferUtils`.
`static VkSparseImageFormatProperties`	`create(long address)` Returns a new `VkSparseImageFormatProperties` instance for the specified memory address.
`static VkSparseImageFormatProperties.Buffer`	`create(long address, int capacity)` Create a `VkSparseImageFormatProperties.Buffer` instance at the specified memory.
`static VkSparseImageFormatProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSparseImageFormatProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkExtent3D`	`imageGranularity()` Returns a `VkExtent3D` view of the `imageGranularity` field.
`static VkSparseImageFormatProperties`	`malloc()` Returns a new `VkSparseImageFormatProperties` instance allocated with `memAlloc`.
`static VkSparseImageFormatProperties.Buffer`	`malloc(int capacity)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated with `memAlloc`.
`static VkSparseImageFormatProperties`	`mallocStack()` Returns a new `VkSparseImageFormatProperties` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageFormatProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSparseImageFormatProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSparseImageFormatProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSparseImageFormatProperties` instance allocated on the specified `MemoryStack`.
`static int`	`naspectMask(long struct)` Unsafe version of `aspectMask()`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static VkExtent3D`	`nimageGranularity(long struct)` Unsafe version of `imageGranularity()`.
`int`	`sizeof()`

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.
  - ASPECTMASK
```
public static final int ASPECTMASK
```
    The struct member offsets.
  - IMAGEGRANULARITY
```
public static final int IMAGEGRANULARITY
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
- Constructor Detail
  - VkSparseImageFormatProperties
```
public VkSparseImageFormatProperties(java.nio.ByteBuffer container)
```
    Creates a VkSparseImageFormatProperties 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
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - imageGranularity
```
public VkExtent3D imageGranularity()
```
    Returns a VkExtent3D view of the imageGranularity field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - malloc
```
public static VkSparseImageFormatProperties malloc()
```
    Returns a new VkSparseImageFormatProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSparseImageFormatProperties calloc()
```
    Returns a new VkSparseImageFormatProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSparseImageFormatProperties create()
```
    Returns a new VkSparseImageFormatProperties instance allocated with BufferUtils.
  - create
```
public static VkSparseImageFormatProperties create(long address)
```
    Returns a new VkSparseImageFormatProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSparseImageFormatProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSparseImageFormatProperties.Buffer malloc(int capacity)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSparseImageFormatProperties.Buffer calloc(int capacity)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageFormatProperties.Buffer create(int capacity)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSparseImageFormatProperties.Buffer create(long address,
                                                          int capacity)
```
    Create a VkSparseImageFormatProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSparseImageFormatProperties.Buffer createSafe(long address,
                                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSparseImageFormatProperties mallocStack()
```
    Returns a new VkSparseImageFormatProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSparseImageFormatProperties callocStack()
```
    Returns a new VkSparseImageFormatProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSparseImageFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageFormatProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSparseImageFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSparseImageFormatProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageFormatProperties.Buffer callocStack(int capacity)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSparseImageFormatProperties.Buffer mallocStack(int capacity,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageFormatProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSparseImageFormatProperties.Buffer callocStack(int capacity,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSparseImageFormatProperties.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
  - naspectMask
```
public static int naspectMask(long struct)
```
    Unsafe version of aspectMask().
  - nimageGranularity
```
public static VkExtent3D nimageGranularity(long struct)
```
    Unsafe version of imageGranularity().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().

Class VkSparseImageFormatProperties

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

ASPECTMASK

IMAGEGRANULARITY

FLAGS

Constructor Detail

VkSparseImageFormatProperties

Method Detail

sizeof

aspectMask

imageGranularity

flags

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

naspectMask

nimageGranularity

nflags