Package org.lwjgl.vulkan
Class VkSurfaceFormat2KHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSurfaceFormat2KHR>
org.lwjgl.vulkan.VkSurfaceFormat2KHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSurfaceFormat2KHR
extends org.lwjgl.system.Struct<VkSurfaceFormat2KHR>
implements org.lwjgl.system.NativeResource
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
imageCompressionControlSwapchainfeature is not enabled, thepNextchain must not include anVkImageCompressionPropertiesEXTstructure
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHRpNextmust beNULLor a pointer to a valid instance ofVkImageCompressionPropertiesEXT- The
sTypevalue of each struct in thepNextchain must be unique
See Also
VkSurfaceFormatKHR, GetPhysicalDeviceSurfaceFormats2KHR
Layout
struct VkSurfaceFormat2KHR {
VkStructureType sType();
void * pNext();
VkSurfaceFormatKHR surfaceFormat();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSurfaceFormat2KHR(ByteBuffer container) Creates aVkSurfaceFormat2KHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSurfaceFormat2KHRcalloc()Returns a newVkSurfaceFormat2KHRinstance allocated withmemCalloc.static VkSurfaceFormat2KHR.Buffercalloc(int capacity) Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withmemCalloc.static VkSurfaceFormat2KHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceFormat2KHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceFormat2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceFormat2KHRDeprecated.static VkSurfaceFormat2KHR.BuffercallocStack(int capacity) Deprecated.static VkSurfaceFormat2KHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceFormat2KHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceFormat2KHRcreate()Returns a newVkSurfaceFormat2KHRinstance allocated withBufferUtils.static VkSurfaceFormat2KHR.Buffercreate(int capacity) Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withBufferUtils.static VkSurfaceFormat2KHRcreate(long address) Returns a newVkSurfaceFormat2KHRinstance for the specified memory address.static VkSurfaceFormat2KHR.Buffercreate(long address, int capacity) Create aVkSurfaceFormat2KHR.Bufferinstance at the specified memory.static @Nullable VkSurfaceFormat2KHRcreateSafe(long address) static @Nullable VkSurfaceFormat2KHR.BuffercreateSafe(long address, int capacity) static VkSurfaceFormat2KHRmalloc()Returns a newVkSurfaceFormat2KHRinstance allocated withmemAlloc.static VkSurfaceFormat2KHR.Buffermalloc(int capacity) Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withmemAlloc.static VkSurfaceFormat2KHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkSurfaceFormat2KHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceFormat2KHRinstance allocated on the specifiedMemoryStack.static VkSurfaceFormat2KHRDeprecated.static VkSurfaceFormat2KHR.BuffermallocStack(int capacity) Deprecated.static VkSurfaceFormat2KHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceFormat2KHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.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.static VkSurfaceFormatKHRnsurfaceFormat(long struct) Unsafe version ofsurfaceFormat().longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkImageCompressionPropertiesEXTvalue to thepNextchain.set(int sType, long pNext) Initializes this struct with the specified values.set(VkSurfaceFormat2KHR src) Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SURFACE_FORMAT_2_KHRvalue to thesType()field.aVkSurfaceFormatKHRstructure describing a format-color space pair that is compatible with the specified surface.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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 aVkSurfaceFormat2KHRinstance 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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkSurfaceFormat2KHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
surfaceFormat
aVkSurfaceFormatKHRstructure 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_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkImageCompressionPropertiesEXTvalue to thepNextchain. -
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 newVkSurfaceFormat2KHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSurfaceFormat2KHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSurfaceFormat2KHRinstance allocated withBufferUtils. -
create
Returns a newVkSurfaceFormat2KHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSurfaceFormat2KHR.Bufferinstance 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 public static VkSurfaceFormat2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkSurfaceFormat2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkSurfaceFormat2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSurfaceFormat2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkSurfaceFormat2KHR.Bufferinstance allocated on the specifiedMemoryStackand 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.
-