Package org.lwjgl.vulkan
Class VkFormatProperties3
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkFormatProperties3
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkFormatProperties3KHR
public class VkFormatProperties3 extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying image format properties.Description
The bits reported in
linearTilingFeatures,optimalTilingFeaturesandbufferFeaturesmust include the bits reported in the corresponding fields ofVkFormatProperties2::formatProperties.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_FORMAT_PROPERTIES_3
Layout
struct VkFormatProperties3 { VkStructureType sType; void * pNext; VkFormatFeatureFlags2linearTilingFeatures(); VkFormatFeatureFlags2optimalTilingFeatures(); VkFormatFeatureFlags2bufferFeatures(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkFormatProperties3.BufferAn array ofVkFormatProperties3structs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intBUFFERFEATURES
LINEARTILINGFEATURES
OPTIMALTILINGFEATURES
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkFormatProperties3(java.nio.ByteBuffer container)Creates aVkFormatProperties3instance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description longbufferFeatures()a bitmask ofVkFormatFeatureFlagBits2specifying features supported by buffers.static VkFormatProperties3calloc()Returns a newVkFormatProperties3instance allocated withmemCalloc.static VkFormatProperties3.Buffercalloc(int capacity)Returns a newVkFormatProperties3.Bufferinstance allocated withmemCalloc.static VkFormatProperties3.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFormatProperties3.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFormatProperties3calloc(org.lwjgl.system.MemoryStack stack)Returns a newVkFormatProperties3instance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFormatProperties3create()Returns a newVkFormatProperties3instance allocated withBufferUtils.static VkFormatProperties3.Buffercreate(int capacity)Returns a newVkFormatProperties3.Bufferinstance allocated withBufferUtils.static VkFormatProperties3create(long address)Returns a newVkFormatProperties3instance for the specified memory address.static VkFormatProperties3.Buffercreate(long address, int capacity)Create aVkFormatProperties3.Bufferinstance at the specified memory.static VkFormatProperties3createSafe(long address)static VkFormatProperties3.BuffercreateSafe(long address, int capacity)longlinearTilingFeatures()a bitmask ofVkFormatFeatureFlagBits2specifying features supported by images created with atilingparameter ofIMAGE_TILING_LINEAR.static VkFormatProperties3malloc()Returns a newVkFormatProperties3instance allocated withmemAlloc.static VkFormatProperties3.Buffermalloc(int capacity)Returns a newVkFormatProperties3.Bufferinstance allocated withmemAlloc.static VkFormatProperties3.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFormatProperties3.Bufferinstance allocated on the specifiedMemoryStack.static VkFormatProperties3malloc(org.lwjgl.system.MemoryStack stack)Returns a newVkFormatProperties3instance allocated on the specifiedMemoryStack.static longnbufferFeatures(long struct)Unsafe version ofbufferFeatures().static longnlinearTilingFeatures(long struct)Unsafe version oflinearTilingFeatures().static longnoptimalTilingFeatures(long struct)Unsafe version ofoptimalTilingFeatures().static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longoptimalTilingFeatures()a bitmask ofVkFormatFeatureFlagBits2specifying features supported by images created with atilingparameter ofIMAGE_TILING_OPTIMAL.longpNext()VkFormatProperties3pNext(long value)Sets the specified value to thepNextfield.VkFormatProperties3set(int sType, long pNext)Initializes this struct with the specified values.VkFormatProperties3set(VkFormatProperties3 src)Copies the specified struct data to this struct.intsizeof()intsType()VkFormatProperties3sType(int value)Sets the specified value to thesTypefield.VkFormatProperties3sType$Default()Sets theSTRUCTURE_TYPE_FORMAT_PROPERTIES_3value to thesTypefield.
-
-
-
Constructor Detail
-
VkFormatProperties3
public VkFormatProperties3(java.nio.ByteBuffer container)
Creates aVkFormatProperties3instance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
- Returns:
- the value of the
sTypefield.
-
pNext
public long pNext()
- Returns:
- the value of the
pNextfield.
-
linearTilingFeatures
public long linearTilingFeatures()
a bitmask ofVkFormatFeatureFlagBits2specifying features supported by images created with atilingparameter ofIMAGE_TILING_LINEAR.
-
optimalTilingFeatures
public long optimalTilingFeatures()
a bitmask ofVkFormatFeatureFlagBits2specifying features supported by images created with atilingparameter ofIMAGE_TILING_OPTIMAL.
-
bufferFeatures
public long bufferFeatures()
a bitmask ofVkFormatFeatureFlagBits2specifying features supported by buffers.
-
sType
public VkFormatProperties3 sType(int value)
Sets the specified value to thesTypefield.
-
sType$Default
public VkFormatProperties3 sType$Default()
Sets theSTRUCTURE_TYPE_FORMAT_PROPERTIES_3value to thesTypefield.
-
pNext
public VkFormatProperties3 pNext(long value)
Sets the specified value to thepNextfield.
-
set
public VkFormatProperties3 set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkFormatProperties3 set(VkFormatProperties3 src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkFormatProperties3 malloc()
Returns a newVkFormatProperties3instance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkFormatProperties3 calloc()
Returns a newVkFormatProperties3instance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkFormatProperties3 create()
Returns a newVkFormatProperties3instance allocated withBufferUtils.
-
create
public static VkFormatProperties3 create(long address)
Returns a newVkFormatProperties3instance for the specified memory address.
-
createSafe
@Nullable public static VkFormatProperties3 createSafe(long address)
-
malloc
public static VkFormatProperties3.Buffer malloc(int capacity)
Returns a newVkFormatProperties3.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkFormatProperties3.Buffer calloc(int capacity)
Returns a newVkFormatProperties3.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkFormatProperties3.Buffer create(int capacity)
Returns a newVkFormatProperties3.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkFormatProperties3.Buffer create(long address, int capacity)
Create aVkFormatProperties3.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkFormatProperties3.Buffer createSafe(long address, int capacity)
-
malloc
public static VkFormatProperties3 malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties3instance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkFormatProperties3 calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties3instance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkFormatProperties3.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties3.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkFormatProperties3.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFormatProperties3.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nlinearTilingFeatures
public static long nlinearTilingFeatures(long struct)
Unsafe version oflinearTilingFeatures().
-
noptimalTilingFeatures
public static long noptimalTilingFeatures(long struct)
Unsafe version ofoptimalTilingFeatures().
-
nbufferFeatures
public static long nbufferFeatures(long struct)
Unsafe version ofbufferFeatures().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
-