Package org.lwjgl.vulkan

Class VkSurfaceProtectedCapabilitiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSurfaceProtectedCapabilitiesKHR>

org.lwjgl.vulkan.VkSurfaceProtectedCapabilitiesKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSurfaceProtectedCapabilitiesKHR
extends Struct<VkSurfaceProtectedCapabilitiesKHR>
implements NativeResource

Structure describing capability of a surface to be protected.

Description

If the VK_GOOGLE_surfaceless_query extension is enabled, the value returned in supportsProtected will be identical for every valid surface created on this physical device, and so in the GetPhysicalDeviceSurfaceCapabilities2KHR call, VkPhysicalDeviceSurfaceInfo2KHR::surface can be NULL_HANDLE. In that case, the contents of VkSurfaceCapabilities2KHR::surfaceCapabilities as well as any other struct chained to it will be undefined.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR

Layout

 struct VkSurfaceProtectedCapabilitiesKHR {
     VkStructureType sType();
     void const * pNext();
     VkBool32 supportsProtected();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSurfaceProtectedCapabilitiesKHR.Buffer	An array of VkSurfaceProtectedCapabilitiesKHR 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

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
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.
static final int	SUPPORTSPROTECTED	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
VkSurfaceProtectedCapabilitiesKHR(ByteBuffer container)	Creates a VkSurfaceProtectedCapabilitiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSurfaceProtectedCapabilitiesKHR	calloc()	Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with memCalloc.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	calloc(int capacity)	Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with memCalloc.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceProtectedCapabilitiesKHR	calloc(MemoryStack stack)	Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSurfaceProtectedCapabilitiesKHR	callocStack()	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR	callocStack(MemoryStack stack)	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR	create()	Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with BufferUtils.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	create(int capacity)	Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with BufferUtils.
static VkSurfaceProtectedCapabilitiesKHR	create(long address)	Returns a new VkSurfaceProtectedCapabilitiesKHR instance for the specified memory address.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	create(long address, int capacity)	Create a VkSurfaceProtectedCapabilitiesKHR.Buffer instance at the specified memory.
static VkSurfaceProtectedCapabilitiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSurfaceProtectedCapabilitiesKHR	malloc()	Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with memAlloc.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	malloc(int capacity)	Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with memAlloc.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkSurfaceProtectedCapabilitiesKHR	malloc(MemoryStack stack)	Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated on the specified MemoryStack.
static VkSurfaceProtectedCapabilitiesKHR	mallocStack()	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSurfaceProtectedCapabilitiesKHR	mallocStack(MemoryStack stack)	Deprecated.
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.
static int	nsupportsProtected(long struct)	Unsafe version of supportsProtected().
static void	nsupportsProtected(long struct, int value)	Unsafe version of supportsProtected.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSurfaceProtectedCapabilitiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkSurfaceProtectedCapabilitiesKHR	set(int sType, long pNext, boolean supportsProtected)	Initializes this struct with the specified values.
VkSurfaceProtectedCapabilitiesKHR	set(VkSurfaceProtectedCapabilitiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkSurfaceProtectedCapabilitiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkSurfaceProtectedCapabilitiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the sType() field.
boolean	supportsProtected()	specifies whether a protected swapchain created from VkPhysicalDeviceSurfaceInfo2KHR::surface for a particular windowing system can be displayed on screen or not.
VkSurfaceProtectedCapabilitiesKHR	supportsProtected(boolean value)	Sets the specified value to the supportsProtected() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

SUPPORTSPROTECTED

public static final int SUPPORTSPROTECTED

The struct member offsets.

Constructor Details

VkSurfaceProtectedCapabilitiesKHR

public VkSurfaceProtectedCapabilitiesKHR(ByteBuffer container)

Creates a VkSurfaceProtectedCapabilitiesKHR 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSurfaceProtectedCapabilitiesKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

supportsProtected

public boolean supportsProtected()

specifies whether a protected swapchain created from VkPhysicalDeviceSurfaceInfo2KHR::surface for a particular windowing system can be displayed on screen or not. If supportsProtected is TRUE, then creation of swapchains with the SWAPCHAIN_CREATE_PROTECTED_BIT_KHR flag set must be supported for surface.

sType

public VkSurfaceProtectedCapabilitiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSurfaceProtectedCapabilitiesKHR sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the sType() field.

pNext

public VkSurfaceProtectedCapabilitiesKHR pNext(long value)

Sets the specified value to the pNext() field.

supportsProtected

public VkSurfaceProtectedCapabilitiesKHR supportsProtected(boolean value)

Sets the specified value to the supportsProtected() field.

set

public VkSurfaceProtectedCapabilitiesKHR set(int sType,
 long pNext,
 boolean supportsProtected)

Initializes this struct with the specified values.

set

public VkSurfaceProtectedCapabilitiesKHR set(VkSurfaceProtectedCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSurfaceProtectedCapabilitiesKHR malloc()

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

calloc

public static VkSurfaceProtectedCapabilitiesKHR calloc()

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

create

public static VkSurfaceProtectedCapabilitiesKHR create()

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with BufferUtils.

create

public static VkSurfaceProtectedCapabilitiesKHR create(long address)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance for the specified memory address.

createSafe

@Nullable
public static VkSurfaceProtectedCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSurfaceProtectedCapabilitiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSurfaceProtectedCapabilitiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSurfaceProtectedCapabilitiesKHR.Buffer create(int capacity)

Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSurfaceProtectedCapabilitiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSurfaceProtectedCapabilitiesKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkSurfaceProtectedCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSurfaceProtectedCapabilitiesKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkSurfaceProtectedCapabilitiesKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSurfaceProtectedCapabilitiesKHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkSurfaceProtectedCapabilitiesKHR.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().

nsupportsProtected

public static int nsupportsProtected(long struct)

Unsafe version of supportsProtected().

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.

nsupportsProtected

public static void nsupportsProtected(long struct,
 int value)

Unsafe version of supportsProtected.