Package org.lwjgl.vulkan
Class VkImageFormatProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageFormatProperties
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageFormatProperties extends Struct
Khronos Reference Page
Vulkan SpecificationContains additional capabilities for certain types of images.
Member documentation
maxExtent
– the maximum image dimensionsmaxMipLevels
– the maximum number of mipmap levelsmaxArrayLayers
– the maximum number of array layerssampleCounts
– a bitmask ofVkSampleCountFlagBits
specifying all the supported sample counts for this image. One or more of:SAMPLE_COUNT_16_BIT
SAMPLE_COUNT_1_BIT
SAMPLE_COUNT_2_BIT
SAMPLE_COUNT_32_BIT
SAMPLE_COUNT_4_BIT
SAMPLE_COUNT_64_BIT
SAMPLE_COUNT_8_BIT
maxResourceSize
– an upper bound on the total image size in bytes, inclusive of all image subresources
Layout
struct VkImageFormatProperties {
VkExtent3D
maxExtent; uint32_t maxMipLevels; uint32_t maxArrayLayers; VkSampleCountFlags sampleCounts; VkDeviceSize maxResourceSize; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkImageFormatProperties.Buffer
An array ofVkImageFormatProperties
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkImageFormatProperties(java.nio.ByteBuffer container)
Creates aVkImageFormatProperties
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkImageFormatProperties
calloc()
Returns a newVkImageFormatProperties
instance allocated withmemCalloc
.static VkImageFormatProperties.Buffer
calloc(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withmemCalloc
.static VkImageFormatProperties
callocStack()
Returns a newVkImageFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties.Buffer
callocStack(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties
callocStack(MemoryStack stack)
Returns a newVkImageFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageFormatProperties
create()
Returns a newVkImageFormatProperties
instance allocated withBufferUtils
.static VkImageFormatProperties.Buffer
create(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withBufferUtils
.static VkImageFormatProperties
create(long address)
Returns a newVkImageFormatProperties
instance for the specified memory address ornull
if the address isNULL
.static VkImageFormatProperties.Buffer
create(long address, int capacity)
Create aVkImageFormatProperties.Buffer
instance at the specified memory.static VkImageFormatProperties
malloc()
Returns a newVkImageFormatProperties
instance allocated withmemAlloc
.static VkImageFormatProperties.Buffer
malloc(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withmemAlloc
.static VkImageFormatProperties
mallocStack()
Returns a newVkImageFormatProperties
instance allocated on the thread-localMemoryStack
.static VkImageFormatProperties.Buffer
mallocStack(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageFormatProperties.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageFormatProperties
mallocStack(MemoryStack stack)
Returns a newVkImageFormatProperties
instance allocated on the specifiedMemoryStack
.int
maxArrayLayers()
Returns the value of themaxArrayLayers
field.VkExtent3D
maxExtent()
Returns aVkExtent3D
view of themaxExtent
field.int
maxMipLevels()
Returns the value of themaxMipLevels
field.long
maxResourceSize()
Returns the value of themaxResourceSize
field.int
sampleCounts()
Returns the value of thesampleCounts
field.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkImageFormatProperties
public VkImageFormatProperties(java.nio.ByteBuffer container)
Creates aVkImageFormatProperties
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
maxExtent
public VkExtent3D maxExtent()
Returns aVkExtent3D
view of themaxExtent
field.
-
maxMipLevels
public int maxMipLevels()
Returns the value of themaxMipLevels
field.
-
maxArrayLayers
public int maxArrayLayers()
Returns the value of themaxArrayLayers
field.
-
sampleCounts
public int sampleCounts()
Returns the value of thesampleCounts
field.
-
maxResourceSize
public long maxResourceSize()
Returns the value of themaxResourceSize
field.
-
malloc
public static VkImageFormatProperties malloc()
Returns a newVkImageFormatProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageFormatProperties calloc()
Returns a newVkImageFormatProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageFormatProperties create()
Returns a newVkImageFormatProperties
instance allocated withBufferUtils
.
-
create
public static VkImageFormatProperties create(long address)
Returns a newVkImageFormatProperties
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkImageFormatProperties.Buffer malloc(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageFormatProperties.Buffer calloc(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatProperties.Buffer create(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageFormatProperties.Buffer create(long address, int capacity)
Create aVkImageFormatProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkImageFormatProperties mallocStack()
Returns a newVkImageFormatProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageFormatProperties callocStack()
Returns a newVkImageFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageFormatProperties mallocStack(MemoryStack stack)
Returns a newVkImageFormatProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageFormatProperties callocStack(MemoryStack stack)
Returns a newVkImageFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageFormatProperties.Buffer mallocStack(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageFormatProperties.Buffer callocStack(int capacity)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageFormatProperties.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageFormatProperties.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-