Class VkPhysicalDeviceSurfaceInfo2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceSurfaceInfo2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPhysicalDeviceSurfaceInfo2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying a surface and related swapchain creation parameters.Description
The members of
VkPhysicalDeviceSurfaceInfo2KHRcorrespond to the arguments toGetPhysicalDeviceSurfaceCapabilitiesKHR, withsTypeandpNextadded 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
VkSurfaceFullScreenExclusiveInfoEXTstructure to thepNextchain of this structure when used to query surface properties. Additionally, for Win32 surfaces with application controlled exclusive full-screen access, chaining aVkSurfaceFullScreenExclusiveWin32InfoEXTstructure may also report additional surface capabilities. These additional capabilities only apply to swapchains created with the same parameters included in thepNextchain ofVkSwapchainCreateInfoKHR.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 - When passed as the
pSurfaceInfoparameter ofGetPhysicalDeviceSurfaceCapabilities2KHR, if theVK_GOOGLE_surfaceless_queryextension is enabled and thepNextchain of thepSurfaceCapabilitiesparameter includesVkSurfaceProtectedCapabilitiesKHR, thensurfacecan beNULL_HANDLE. Otherwise,surfacemust be a validVkSurfaceKHRhandle - When passed as the
pSurfaceInfoparameter ofGetPhysicalDeviceSurfaceFormats2KHR, if theVK_GOOGLE_surfaceless_queryextension is enabled, thensurfacecan beNULL_HANDLE. Otherwise,surfacemust be a validVkSurfaceKHRhandle - When passed as the
pSurfaceInfoparameter ofGetPhysicalDeviceSurfacePresentModes2EXT, if theVK_GOOGLE_surfaceless_queryextension is enabled, thensurfacecan beNULL_HANDLE. Otherwise,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 ofVkSurfaceFullScreenExclusiveInfoEXTorVkSurfaceFullScreenExclusiveWin32InfoEXT - The
sTypevalue of each struct in thepNextchain must be unique - If
surfaceis notNULL_HANDLE,surfacemust be a validVkSurfaceKHRhandle
See Also
GetDeviceGroupSurfacePresentModes2EXT,GetPhysicalDeviceSurfaceCapabilities2KHR,GetPhysicalDeviceSurfaceFormats2KHR,GetPhysicalDeviceSurfacePresentModes2EXTLayout
struct VkPhysicalDeviceSurfaceInfo2KHR { VkStructureTypesType(); void const *pNext(); VkSurfaceKHRsurface(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPhysicalDeviceSurfaceInfo2KHR.BufferAn array ofVkPhysicalDeviceSurfaceInfo2KHRstructs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceSurfaceInfo2KHR(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceSurfaceInfo2KHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkPhysicalDeviceSurfaceInfo2KHRcalloc()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemCalloc.static VkPhysicalDeviceSurfaceInfo2KHR.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceSurfaceInfo2KHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHRcallocStack()Deprecated.static VkPhysicalDeviceSurfaceInfo2KHR.BuffercallocStack(int capacity)Deprecated.static VkPhysicalDeviceSurfaceInfo2KHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceSurfaceInfo2KHRcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceSurfaceInfo2KHRcreate()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withBufferUtils.static VkPhysicalDeviceSurfaceInfo2KHR.Buffercreate(int capacity)Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceSurfaceInfo2KHRcreate(long address)Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance for the specified memory address.static VkPhysicalDeviceSurfaceInfo2KHR.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance at the specified memory.static VkPhysicalDeviceSurfaceInfo2KHRcreateSafe(long address)static VkPhysicalDeviceSurfaceInfo2KHR.BuffercreateSafe(long address, int capacity)static VkPhysicalDeviceSurfaceInfo2KHRmalloc()Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemAlloc.static VkPhysicalDeviceSurfaceInfo2KHR.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceSurfaceInfo2KHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceSurfaceInfo2KHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceSurfaceInfo2KHRmallocStack()Deprecated.static VkPhysicalDeviceSurfaceInfo2KHR.BuffermallocStack(int capacity)Deprecated.static VkPhysicalDeviceSurfaceInfo2KHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPhysicalDeviceSurfaceInfo2KHRmallocStack(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.VkPhysicalDeviceSurfaceInfo2KHRpNext(long value)Sets the specified value to thepNext()field.VkPhysicalDeviceSurfaceInfo2KHRpNext(VkSurfaceFullScreenExclusiveInfoEXT value)Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXTvalue to thepNextchain.VkPhysicalDeviceSurfaceInfo2KHRpNext(VkSurfaceFullScreenExclusiveWin32InfoEXT value)Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXTvalue to thepNextchain.VkPhysicalDeviceSurfaceInfo2KHRset(int sType, long pNext, long surface)Initializes this struct with the specified values.VkPhysicalDeviceSurfaceInfo2KHRset(VkPhysicalDeviceSurfaceInfo2KHR src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkPhysicalDeviceSurfaceInfo2KHRsType(int value)Sets the specified value to thesType()field.VkPhysicalDeviceSurfaceInfo2KHRsType$Default()Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHRvalue to thesType()field.longsurface()the surface that will be associated with the swapchain.VkPhysicalDeviceSurfaceInfo2KHRsurface(long value)Sets the specified value to thesurface()field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceSurfaceInfo2KHR
public VkPhysicalDeviceSurfaceInfo2KHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
public VkPhysicalDeviceSurfaceInfo2KHR sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPhysicalDeviceSurfaceInfo2KHR sType$Default()
Sets theSTRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHRvalue to thesType()field.
-
pNext
public VkPhysicalDeviceSurfaceInfo2KHR pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkPhysicalDeviceSurfaceInfo2KHR pNext(VkSurfaceFullScreenExclusiveInfoEXT value)
Prepends the specifiedVkSurfaceFullScreenExclusiveInfoEXTvalue to thepNextchain.
-
pNext
public VkPhysicalDeviceSurfaceInfo2KHR pNext(VkSurfaceFullScreenExclusiveWin32InfoEXT value)
Prepends the specifiedVkSurfaceFullScreenExclusiveWin32InfoEXTvalue to thepNextchain.
-
surface
public VkPhysicalDeviceSurfaceInfo2KHR surface(long value)
Sets the specified value to thesurface()field.
-
set
public VkPhysicalDeviceSurfaceInfo2KHR set(int sType, long pNext, long surface)
Initializes this struct with the specified values.
-
set
public VkPhysicalDeviceSurfaceInfo2KHR set(VkPhysicalDeviceSurfaceInfo2KHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPhysicalDeviceSurfaceInfo2KHR malloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR calloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR create()
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR create(long address)
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceSurfaceInfo2KHR createSafe(long address)
-
malloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer create(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceSurfaceInfo2KHR.Bufferinstance 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 public static VkPhysicalDeviceSurfaceInfo2KHR mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceSurfaceInfo2KHR 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 public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer callocStack(int capacity)
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
public static VkPhysicalDeviceSurfaceInfo2KHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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.
-
-