Package org.lwjgl.vulkan

Class VkSurfaceFullScreenExclusiveWin32InfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSurfaceFullScreenExclusiveWin32InfoEXT>

org.lwjgl.vulkan.VkSurfaceFullScreenExclusiveWin32InfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkSurfaceFullScreenExclusiveWin32InfoEXT
extends org.lwjgl.system.Struct<VkSurfaceFullScreenExclusiveWin32InfoEXT>
implements org.lwjgl.system.NativeResource

Structure specifying additional creation parameters specific to Win32 fullscreen exclusive mode.

Description

Note

If hmonitor is invalidated (e.g. the monitor is unplugged) during the lifetime of a swapchain created with this structure, operations on that swapchain will return ERROR_OUT_OF_DATE_KHR.

Note

It is the responsibility of the application to change the display settings of the targeted Win32 display using the appropriate platform APIs. Such changes may alter the surface capabilities reported for the created surface.

Valid Usage

• hmonitor must be a valid HMONITOR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_WIN32_INFO_EXT

Layout

 struct VkSurfaceFullScreenExclusiveWin32InfoEXT {
     VkStructureType sType();
     void const * pNext();
     HMONITOR hmonitor();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	An array of VkSurfaceFullScreenExclusiveWin32InfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	HMONITOR	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkSurfaceFullScreenExclusiveWin32InfoEXT(ByteBuffer container)	Creates a VkSurfaceFullScreenExclusiveWin32InfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSurfaceFullScreenExclusiveWin32InfoEXT	calloc()	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with memCalloc.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	calloc(int capacity)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with memCalloc.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	callocStack()	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	create()	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with BufferUtils.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	create(int capacity)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with BufferUtils.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	create(long address)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance for the specified memory address.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	create(long address, int capacity)	Create a VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance at the specified memory.
static @Nullable VkSurfaceFullScreenExclusiveWin32InfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	hmonitor()	the Win32 HMONITOR handle identifying the display to create the surface with.
VkSurfaceFullScreenExclusiveWin32InfoEXT	hmonitor(long value)	Sets the specified value to the hmonitor() field.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	malloc()	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with memAlloc.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	malloc(int capacity)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with memAlloc.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated on the specified MemoryStack.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	mallocStack()	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSurfaceFullScreenExclusiveWin32InfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	nhmonitor(long struct)	Unsafe version of hmonitor().
static void	nhmonitor(long struct, long value)	Unsafe version of hmonitor.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSurfaceFullScreenExclusiveWin32InfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkSurfaceFullScreenExclusiveWin32InfoEXT	set(int sType, long pNext, long hmonitor)	Initializes this struct with the specified values.
VkSurfaceFullScreenExclusiveWin32InfoEXT	set(VkSurfaceFullScreenExclusiveWin32InfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSurfaceFullScreenExclusiveWin32InfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSurfaceFullScreenExclusiveWin32InfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_WIN32_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

HMONITOR

public static final int HMONITOR

The struct member offsets.

Constructor Details

VkSurfaceFullScreenExclusiveWin32InfoEXT

public VkSurfaceFullScreenExclusiveWin32InfoEXT(ByteBuffer container)

Creates a VkSurfaceFullScreenExclusiveWin32InfoEXT instance at the current position of the specified ByteBuffer 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkSurfaceFullScreenExclusiveWin32InfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

hmonitor

public long hmonitor()

the Win32 HMONITOR handle identifying the display to create the surface with.

sType

public VkSurfaceFullScreenExclusiveWin32InfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSurfaceFullScreenExclusiveWin32InfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_FULL_SCREEN_EXCLUSIVE_WIN32_INFO_EXT value to the sType() field.

pNext

public VkSurfaceFullScreenExclusiveWin32InfoEXT pNext(long value)

Sets the specified value to the pNext() field.

hmonitor

public VkSurfaceFullScreenExclusiveWin32InfoEXT hmonitor(long value)

Sets the specified value to the hmonitor() field.

set

public VkSurfaceFullScreenExclusiveWin32InfoEXT set(int sType,
 long pNext,
 long hmonitor)

Initializes this struct with the specified values.

set

public VkSurfaceFullScreenExclusiveWin32InfoEXT set(VkSurfaceFullScreenExclusiveWin32InfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT malloc()

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT calloc()

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkSurfaceFullScreenExclusiveWin32InfoEXT create()

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated with BufferUtils.

create

public static VkSurfaceFullScreenExclusiveWin32InfoEXT create(long address)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSurfaceFullScreenExclusiveWin32InfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer malloc(int capacity)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer calloc(int capacity)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer create(int capacity)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer create(long address,
 int capacity)

Create a VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkSurfaceFullScreenExclusiveWin32InfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nhmonitor

public static long nhmonitor(long struct)

Unsafe version of hmonitor().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nhmonitor

public static void nhmonitor(long struct,
 long value)

Unsafe version of hmonitor.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate