Package org.lwjgl.vulkan
Class VkSurfaceFormat2KHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Structure describing a supported swapchain format tuple.
Description
If the imageCompressionControlSwapchain
feature is supported and a VkImageCompressionPropertiesEXT
structure is included in the pNext
chain of this structure, then it will be filled with the compression properties that are supported for the surfaceFormat
.
Valid Usage
- If the
imageCompressionControlSwapchain
feature is not enabled, thepNext
chain must not include anVkImageCompressionPropertiesEXT
structure
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHR
pNext
must beNULL
or a pointer to a valid instance ofVkImageCompressionPropertiesEXT
- The
sType
value of each struct in thepNext
chain must be unique
See Also
VkSurfaceFormatKHR
, GetPhysicalDeviceSurfaceFormats2KHR
Layout
struct VkSurfaceFormat2KHR {
VkStructureType sType()
;
void * pNext()
;
VkSurfaceFormatKHR
surfaceFormat()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkSurfaceFormat2KHR
(ByteBuffer container) Creates aVkSurfaceFormat2KHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSurfaceFormat2KHR
calloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemCalloc
.static VkSurfaceFormat2KHR.Buffer
calloc
(int capacity) Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemCalloc
.static VkSurfaceFormat2KHR.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR
calloc
(MemoryStack stack) Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceFormat2KHR
Deprecated.static VkSurfaceFormat2KHR.Buffer
callocStack
(int capacity) Deprecated.static VkSurfaceFormat2KHR.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkSurfaceFormat2KHR
callocStack
(MemoryStack stack) Deprecated.static VkSurfaceFormat2KHR
create()
Returns a newVkSurfaceFormat2KHR
instance allocated withBufferUtils
.static VkSurfaceFormat2KHR.Buffer
create
(int capacity) Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withBufferUtils
.static VkSurfaceFormat2KHR
create
(long address) Returns a newVkSurfaceFormat2KHR
instance for the specified memory address.static VkSurfaceFormat2KHR.Buffer
create
(long address, int capacity) Create aVkSurfaceFormat2KHR.Buffer
instance at the specified memory.static VkSurfaceFormat2KHR
createSafe
(long address) static VkSurfaceFormat2KHR.Buffer
createSafe
(long address, int capacity) static VkSurfaceFormat2KHR
malloc()
Returns a newVkSurfaceFormat2KHR
instance allocated withmemAlloc
.static VkSurfaceFormat2KHR.Buffer
malloc
(int capacity) Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemAlloc
.static VkSurfaceFormat2KHR.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkSurfaceFormat2KHR
malloc
(MemoryStack stack) Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
.static VkSurfaceFormat2KHR
Deprecated.static VkSurfaceFormat2KHR.Buffer
mallocStack
(int capacity) Deprecated.static VkSurfaceFormat2KHR.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkSurfaceFormat2KHR
mallocStack
(MemoryStack stack) Deprecated.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static VkSurfaceFormatKHR
nsurfaceFormat
(long struct) Unsafe version ofsurfaceFormat()
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.Prepends the specifiedVkImageCompressionPropertiesEXT
value to thepNext
chain.set
(int sType, long pNext) Initializes this struct with the specified values.set
(VkSurfaceFormat2KHR src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHR
value to thesType()
field.aVkSurfaceFormatKHR
structure describing a format-color space pair that is compatible with the specified surface.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
SURFACEFORMAT
public static final int SURFACEFORMATThe struct member offsets.
-
-
Constructor Details
-
VkSurfaceFormat2KHR
Creates aVkSurfaceFormat2KHR
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSurfaceFormat2KHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
surfaceFormat
aVkSurfaceFormatKHR
structure describing a format-color space pair that is compatible with the specified surface. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pNext
Prepends the specifiedVkImageCompressionPropertiesEXT
value to thepNext
chain. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSurfaceFormat2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSurfaceFormat2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSurfaceFormat2KHR
instance allocated withBufferUtils
. -
create
Returns a newVkSurfaceFormat2KHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSurfaceFormat2KHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSurfaceFormat2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSurfaceFormat2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nsurfaceFormat
Unsafe version ofsurfaceFormat()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
.
-