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.NativeResource
Structure specifying a surface and related swapchain creation parameters.Description
The members of
VkPhysicalDeviceSurfaceInfo2KHR
correspond to the arguments toGetPhysicalDeviceSurfaceCapabilitiesKHR
, withsType
andpNext
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 including the
VkSurfaceFullScreenExclusiveInfoEXT
structure in thepNext
chain of this structure when used to query surface properties. Additionally, for Win32 surfaces with application controlled exclusive full-screen access, chaining a valid instance of theVkSurfaceFullScreenExclusiveWin32InfoEXT
structure may also report additional surface capabilities. These additional capabilities only apply to swapchains created with the same parameters passed into thepNext
chain ofVkSwapchainCreateInfoKHR
.Valid Usage
- If the
pNext
chain includes an instance ofVkSurfaceFullScreenExclusiveInfoEXT
with itsfullScreenExclusive
member set toFULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT
, andsurface
was created usingCreateWin32SurfaceKHR
, an instance ofVkSurfaceFullScreenExclusiveWin32InfoEXT
must be present in thepNext
chain
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
orVkSurfaceFullScreenExclusiveWin32InfoEXT
- Each
sType
member in thepNext
chain must be unique surface
must be a validVkSurfaceKHR
handle
See Also
GetDeviceGroupSurfacePresentModes2EXT
,GetPhysicalDeviceSurfaceCapabilities2KHR
,GetPhysicalDeviceSurfaceFormats2KHR
,GetPhysicalDeviceSurfacePresentModes2EXT
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.surface
– the surface that will be associated with the swapchain.
Layout
struct VkPhysicalDeviceSurfaceInfo2KHR { VkStructureType sType; void const * pNext; VkSurfaceKHR surface; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPhysicalDeviceSurfaceInfo2KHR.Buffer
An array ofVkPhysicalDeviceSurfaceInfo2KHR
structs.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceSurfaceInfo2KHR(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceSurfaceInfo2KHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceSurfaceInfo2KHR
calloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemCalloc
.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceSurfaceInfo2KHR
callocStack()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceSurfaceInfo2KHR
create()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withBufferUtils
.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceSurfaceInfo2KHR
create(long address)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance for the specified memory address.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance at the specified memory.static VkPhysicalDeviceSurfaceInfo2KHR
createSafe(long address)
static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
createSafe(long address, int capacity)
static VkPhysicalDeviceSurfaceInfo2KHR
malloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemAlloc
.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceSurfaceInfo2KHR
mallocStack()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceSurfaceInfo2KHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceSurfaceInfo2KHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
.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()
Returns the value of thepNext
field.VkPhysicalDeviceSurfaceInfo2KHR
pNext(long value)
Sets the specified value to thepNext
field.VkPhysicalDeviceSurfaceInfo2KHR
set(int sType, long pNext, long surface)
Initializes this struct with the specified values.VkPhysicalDeviceSurfaceInfo2KHR
set(VkPhysicalDeviceSurfaceInfo2KHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPhysicalDeviceSurfaceInfo2KHR
sType(int value)
Sets the specified value to thesType
field.long
surface()
Returns the value of thesurface
field.VkPhysicalDeviceSurfaceInfo2KHR
surface(long value)
Sets the specified value to thesurface
field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceSurfaceInfo2KHR
public VkPhysicalDeviceSurfaceInfo2KHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
surface
public long surface()
Returns the value of thesurface
field.
-
sType
public VkPhysicalDeviceSurfaceInfo2KHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPhysicalDeviceSurfaceInfo2KHR pNext(long value)
Sets the specified value to thepNext
field.
-
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 newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR calloc()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR create()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR create(long address)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceSurfaceInfo2KHR createSafe(long address)
-
malloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer create(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer create(long address, int capacity)
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
public static VkPhysicalDeviceSurfaceInfo2KHR mallocStack()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceSurfaceInfo2KHR callocStack()
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceSurfaceInfo2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceSurfaceInfo2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSurfaceInfo2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceSurfaceInfo2KHR.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-