Class VkPhysicalDeviceSurfaceInfo2KHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
The members of VkPhysicalDeviceSurfaceInfo2KHR correspond to the arguments to GetPhysicalDeviceSurfaceCapabilitiesKHR, with sType and pNext added for extensibility.
Additional capabilities of a surface may be available to swapchains created with different full-screen exclusive settings - particularly if exclusive full-screen access is application controlled. These additional capabilities can be queried by adding a VkSurfaceFullScreenExclusiveInfoEXT structure to the pNext chain of this structure when used to query surface properties. Additionally, for Win32 surfaces with application controlled exclusive full-screen access, chaining a VkSurfaceFullScreenExclusiveWin32InfoEXT structure may also report additional surface capabilities. These additional capabilities only apply to swapchains created with the same parameters included in the pNext chain of VkSwapchainCreateInfoKHR.
Valid Usage
- If the
pNextchain includes aVkSurfaceFullScreenExclusiveInfoEXTstructure with itsfullScreenExclusivemember set toFULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT, andsurfacewas created usingCreateWin32SurfaceKHR, aVkSurfaceFullScreenExclusiveWin32InfoEXTstructure must be included in thepNextchain - If surface is not VK_NULL_HANDLE, and the
VK_GOOGLE_surfaceless_queryextension is not enabled,surfacemust be a validVkSurfaceKHRhandle
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkSurfaceFullScreenExclusiveInfoEXT,VkSurfaceFullScreenExclusiveWin32InfoEXT, orVkSurfacePresentModeEXT - The
sTypevalue of each struct in thepNextchain must be unique
See Also
GetDeviceGroupSurfacePresentModes2EXT, GetPhysicalDeviceSurfaceCapabilities2KHR, GetPhysicalDeviceSurfaceFormats2KHR, GetPhysicalDeviceSurfacePresentModes2EXT
Layout
struct VkPhysicalDeviceSurfaceInfo2KHR {
VkStructureType sType();
void const * pNext();
VkSurfaceKHR surface();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPhysicalDeviceSurfaceInfo2KHRstructs.Nested 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
ConstructorsConstructorDescriptionVkPhysicalDeviceSurfaceInfo2KHR(ByteBuffer container) Creates aVkPhysicalDeviceSurfaceInfo2KHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance for the specified memory address.create(long address, int capacity) Create aVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance at the specified memory.static @Nullable VkPhysicalDeviceSurfaceInfo2KHRcreateSafe(long address) static @Nullable VkPhysicalDeviceSurfaceInfo2KHR.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(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 longnsurface(long struct) Unsafe version ofsurface().static voidnsurface(long struct, long value) Unsafe version ofsurface.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXTvalue to thepNextchain.Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXTvalue to thepNextchain.pNext(VkSurfacePresentModeEXT value) Prepends the specifiedVkSurfacePresentModeEXTvalue to thepNextchain.set(int sType, long pNext, long surface) 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_PHYSICAL_DEVICE_SURFACE_INFO_2_KHRvalue to thesType()field.longsurface()the surface that will be associated with the swapchain.surface(long value) Sets the specified value to thesurface()field.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. -
SURFACE
public static final int SURFACEThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceSurfaceInfo2KHR
Creates aVkPhysicalDeviceSurfaceInfo2KHRinstance 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<VkPhysicalDeviceSurfaceInfo2KHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
surface
public long surface()the surface that will be associated with the swapchain. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXTvalue to thepNextchain. -
pNext
Prepends the specifiedVkSurfacePresentModeEXTvalue to thepNextchain. -
surface
Sets the specified value to thesurface()field. -
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 newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withBufferUtils. -
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPhysicalDeviceSurfaceInfo2KHR.Buffer createSafe(long address, int capacity) -
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 public static VkPhysicalDeviceSurfaceInfo2KHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPhysicalDeviceSurfaceInfo2KHR callocStack(org.lwjgl.system.MemoryStack stack) 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 VkPhysicalDeviceSurfaceInfo2KHR.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 VkPhysicalDeviceSurfaceInfo2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.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(). -
nsurface
public static long nsurface(long struct) Unsafe version ofsurface(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nsurface
public static void nsurface(long struct, long value) Unsafe version ofsurface.
-