Class VkPhysicalDeviceSurfaceInfo2KHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,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
pNext
chain includes aVkSurfaceFullScreenExclusiveInfoEXT
structure with itsfullScreenExclusive
member set toFULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT
, andsurface
was created usingCreateWin32SurfaceKHR
, aVkSurfaceFullScreenExclusiveWin32InfoEXT
structure must be included in thepNext
chain - If the
VK_GOOGLE_surfaceless_query
extension is not enabled,surface
must be a validVkSurfaceKHR
handle
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkSurfaceFullScreenExclusiveInfoEXT
,VkSurfaceFullScreenExclusiveWin32InfoEXT
, orVkSurfacePresentModeEXT
- The
sType
value of each struct in thepNext
chain must be unique - If
surface
is notNULL_HANDLE
,surface
must be a validVkSurfaceKHR
handle
See Also
GetDeviceGroupSurfacePresentModes2EXT
, GetPhysicalDeviceSurfaceCapabilities2KHR
, GetPhysicalDeviceSurfaceFormats2KHR
, GetPhysicalDeviceSurfacePresentModes2EXT
Layout
struct VkPhysicalDeviceSurfaceInfo2KHR {
VkStructureType sType()
;
void const * pNext()
;
VkSurfaceKHR surface()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPhysicalDeviceSurfaceInfo2KHR
structs.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
ConstructorDescriptionVkPhysicalDeviceSurfaceInfo2KHR
(ByteBuffer container) Creates aVkPhysicalDeviceSurfaceInfo2KHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance for the specified memory address.create
(long address, int capacity) Create aVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) malloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.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 long
nsurface
(long struct) Unsafe version ofsurface()
.static void
nsurface
(long struct, long value) Unsafe version ofsurface
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXT
value to thepNext
chain.Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXT
value to thepNext
chain.pNext
(VkSurfacePresentModeEXT value) Prepends the specifiedVkSurfacePresentModeEXT
value to thepNext
chain.set
(int sType, long pNext, long surface) Initializes this struct with the specified values.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_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR
value to thesType()
field.long
surface()
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.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. -
SURFACE
public static final int SURFACEThe struct member offsets.
-
-
Constructor Details
-
VkPhysicalDeviceSurfaceInfo2KHR
Creates aVkPhysicalDeviceSurfaceInfo2KHR
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<VkPhysicalDeviceSurfaceInfo2KHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or 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_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pNext
Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXT
value to thepNext
chain. -
pNext
Prepends the specifiedVkSurfacePresentModeEXT
value to thepNext
chain. -
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 newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withBufferUtils
. -
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static 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.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 VkPhysicalDeviceSurfaceInfo2KHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.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()
. -
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
.
-