Package org.lwjgl.vulkan
Class VkFormatProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkFormatProperties
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkFormatProperties extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying image format properties.Description
Note
If no format feature flags are supported, the format itself is not supported, and images of that format cannot be created.
If
format
is a block-compressed format, thenbufferFeatures
must not support any features for the format.If
format
is not a multi-plane format thenlinearTilingFeatures
andoptimalTilingFeatures
must not containFORMAT_FEATURE_DISJOINT_BIT
.See Also
VkFormatProperties2
,GetPhysicalDeviceFormatProperties
Member documentation
linearTilingFeatures
– a bitmask ofVkFormatFeatureFlagBits
specifying features supported by images created with atiling
parameter ofIMAGE_TILING_LINEAR
.optimalTilingFeatures
– a bitmask ofVkFormatFeatureFlagBits
specifying features supported by images created with atiling
parameter ofIMAGE_TILING_OPTIMAL
.bufferFeatures
– a bitmask ofVkFormatFeatureFlagBits
specifying features supported by buffers.
Layout
struct VkFormatProperties { VkFormatFeatureFlags linearTilingFeatures; VkFormatFeatureFlags optimalTilingFeatures; VkFormatFeatureFlags bufferFeatures; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkFormatProperties.Buffer
An array ofVkFormatProperties
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
BUFFERFEATURES
LINEARTILINGFEATURES
OPTIMALTILINGFEATURESThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkFormatProperties(java.nio.ByteBuffer container)
Creates aVkFormatProperties
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
bufferFeatures()
Returns the value of thebufferFeatures
field.static VkFormatProperties
calloc()
Returns a newVkFormatProperties
instance allocated withmemCalloc
.static VkFormatProperties.Buffer
calloc(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withmemCalloc
.static VkFormatProperties
callocStack()
Returns a newVkFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFormatProperties.Buffer
callocStack(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFormatProperties.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFormatProperties
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFormatProperties
create()
Returns a newVkFormatProperties
instance allocated withBufferUtils
.static VkFormatProperties.Buffer
create(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withBufferUtils
.static VkFormatProperties
create(long address)
Returns a newVkFormatProperties
instance for the specified memory address.static VkFormatProperties.Buffer
create(long address, int capacity)
Create aVkFormatProperties.Buffer
instance at the specified memory.static VkFormatProperties
createSafe(long address)
static VkFormatProperties.Buffer
createSafe(long address, int capacity)
int
linearTilingFeatures()
Returns the value of thelinearTilingFeatures
field.static VkFormatProperties
malloc()
Returns a newVkFormatProperties
instance allocated withmemAlloc
.static VkFormatProperties.Buffer
malloc(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withmemAlloc
.static VkFormatProperties
mallocStack()
Returns a newVkFormatProperties
instance allocated on the thread-localMemoryStack
.static VkFormatProperties.Buffer
mallocStack(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkFormatProperties.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkFormatProperties
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties
instance allocated on the specifiedMemoryStack
.static int
nbufferFeatures(long struct)
Unsafe version ofbufferFeatures()
.static int
nlinearTilingFeatures(long struct)
Unsafe version oflinearTilingFeatures()
.static int
noptimalTilingFeatures(long struct)
Unsafe version ofoptimalTilingFeatures()
.int
optimalTilingFeatures()
Returns the value of theoptimalTilingFeatures
field.int
sizeof()
-
-
-
Constructor Detail
-
VkFormatProperties
public VkFormatProperties(java.nio.ByteBuffer container)
Creates aVkFormatProperties
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
-
linearTilingFeatures
public int linearTilingFeatures()
Returns the value of thelinearTilingFeatures
field.
-
optimalTilingFeatures
public int optimalTilingFeatures()
Returns the value of theoptimalTilingFeatures
field.
-
bufferFeatures
public int bufferFeatures()
Returns the value of thebufferFeatures
field.
-
malloc
public static VkFormatProperties malloc()
Returns a newVkFormatProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkFormatProperties calloc()
Returns a newVkFormatProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkFormatProperties create()
Returns a newVkFormatProperties
instance allocated withBufferUtils
.
-
create
public static VkFormatProperties create(long address)
Returns a newVkFormatProperties
instance for the specified memory address.
-
createSafe
@Nullable public static VkFormatProperties createSafe(long address)
-
malloc
public static VkFormatProperties.Buffer malloc(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkFormatProperties.Buffer calloc(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFormatProperties.Buffer create(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFormatProperties.Buffer create(long address, int capacity)
Create aVkFormatProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkFormatProperties.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkFormatProperties mallocStack()
Returns a newVkFormatProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkFormatProperties callocStack()
Returns a newVkFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkFormatProperties.Buffer mallocStack(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkFormatProperties.Buffer callocStack(int capacity)
Returns a newVkFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkFormatProperties.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkFormatProperties.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nlinearTilingFeatures
public static int nlinearTilingFeatures(long struct)
Unsafe version oflinearTilingFeatures()
.
-
noptimalTilingFeatures
public static int noptimalTilingFeatures(long struct)
Unsafe version ofoptimalTilingFeatures()
.
-
nbufferFeatures
public static int nbufferFeatures(long struct)
Unsafe version ofbufferFeatures()
.
-
-