Package org.lwjgl.vulkan
Class VkSurfaceCapabilities2KHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSurfaceCapabilities2KHR>
org.lwjgl.vulkan.VkSurfaceCapabilities2KHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSurfaceCapabilities2KHR
extends org.lwjgl.system.Struct<VkSurfaceCapabilities2KHR>
implements org.lwjgl.system.NativeResource
Structure describing capabilities of a surface.
Description
If the VK_GOOGLE_surfaceless_query extension is enabled and VkPhysicalDeviceSurfaceInfo2KHR::surface in the GetPhysicalDeviceSurfaceCapabilities2KHR call is NULL_HANDLE, the values returned in minImageCount, maxImageCount, currentExtent, and currentTransform will not reflect that of any surface and will instead be as such:
minImageCountandmaxImageCountwill be0xFFFFFFFFcurrentExtentwill be(0xFFFFFFFF, 0xFFFFFFFF)currentTransformwill beSURFACE_TRANSFORM_INHERIT_BIT_KHR
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkDisplayNativeHdrSurfaceCapabilitiesAMD,VkLatencySurfaceCapabilitiesNV,VkSharedPresentSurfaceCapabilitiesKHR,VkSurfaceCapabilitiesFullScreenExclusiveEXT,VkSurfaceCapabilitiesPresentBarrierNV,VkSurfacePresentModeCompatibilityEXT,VkSurfacePresentScalingCapabilitiesEXT, orVkSurfaceProtectedCapabilitiesKHR - The
sTypevalue of each struct in thepNextchain must be unique
See Also
VkSurfaceCapabilitiesKHR, GetPhysicalDeviceSurfaceCapabilities2KHR
Layout
struct VkSurfaceCapabilities2KHR {
VkStructureType sType();
void * pNext();
VkSurfaceCapabilitiesKHR surfaceCapabilities();
}-
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
ConstructorsConstructorDescriptionVkSurfaceCapabilities2KHR(ByteBuffer container) Creates aVkSurfaceCapabilities2KHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSurfaceCapabilities2KHRcalloc()Returns a newVkSurfaceCapabilities2KHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceCapabilities2KHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceCapabilities2KHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceCapabilities2KHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceCapabilities2KHRcreate()Returns a newVkSurfaceCapabilities2KHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withBufferUtils.static VkSurfaceCapabilities2KHRcreate(long address) Returns a newVkSurfaceCapabilities2KHRinstance for the specified memory address.create(long address, int capacity) Create aVkSurfaceCapabilities2KHR.Bufferinstance at the specified memory.static @Nullable VkSurfaceCapabilities2KHRcreateSafe(long address) static @Nullable VkSurfaceCapabilities2KHR.BuffercreateSafe(long address, int capacity) static VkSurfaceCapabilities2KHRmalloc()Returns a newVkSurfaceCapabilities2KHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkSurfaceCapabilities2KHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHRinstance allocated on the specifiedMemoryStack.static VkSurfaceCapabilities2KHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkSurfaceCapabilities2KHRmallocStack(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 VkSurfaceCapabilitiesKHRnsurfaceCapabilities(long struct) Unsafe version ofsurfaceCapabilities().longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkDisplayNativeHdrSurfaceCapabilitiesAMDvalue to thepNextchain.Prepends the specifiedVkLatencySurfaceCapabilitiesNVvalue to thepNextchain.Prepends the specifiedVkSharedPresentSurfaceCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkSurfaceCapabilitiesFullScreenExclusiveEXTvalue to thepNextchain.Prepends the specifiedVkSurfaceCapabilitiesPresentBarrierNVvalue to thepNextchain.Prepends the specifiedVkSurfacePresentModeCompatibilityEXTvalue to thepNextchain.Prepends the specifiedVkSurfacePresentScalingCapabilitiesEXTvalue to thepNextchain.Prepends the specifiedVkSurfaceProtectedCapabilitiesKHRvalue to thepNextchain.set(int sType, long pNext) Initializes this struct with the specified values.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_CAPABILITIES_2_KHRvalue to thesType()field.aVkSurfaceCapabilitiesKHRstructure describing the capabilities of 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. -
SURFACECAPABILITIES
public static final int SURFACECAPABILITIESThe struct member offsets.
-
-
Constructor Details
-
VkSurfaceCapabilities2KHR
Creates aVkSurfaceCapabilities2KHRinstance 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<VkSurfaceCapabilities2KHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
surfaceCapabilities
aVkSurfaceCapabilitiesKHRstructure describing the capabilities of the specified surface. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkDisplayNativeHdrSurfaceCapabilitiesAMDvalue to thepNextchain. -
pNext
Prepends the specifiedVkLatencySurfaceCapabilitiesNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfaceCapabilitiesFullScreenExclusiveEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfaceCapabilitiesPresentBarrierNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfacePresentModeCompatibilityEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfacePresentScalingCapabilitiesEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfaceProtectedCapabilitiesKHRvalue 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 newVkSurfaceCapabilities2KHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSurfaceCapabilities2KHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSurfaceCapabilities2KHRinstance allocated withBufferUtils. -
create
Returns a newVkSurfaceCapabilities2KHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSurfaceCapabilities2KHR.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 VkSurfaceCapabilities2KHR.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 VkSurfaceCapabilities2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkSurfaceCapabilities2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSurfaceCapabilities2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSurfaceCapabilities2KHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkSurfaceCapabilities2KHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfaceCapabilities2KHR.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(). -
nsurfaceCapabilities
Unsafe version ofsurfaceCapabilities(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext.
-