Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSurfaceProtectedCapabilitiesKHR

extends Struct<VkSurfaceProtectedCapabilitiesKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSurfaceProtectedCapabilitiesKHR.Buffer

An array of VkSurfaceProtectedCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SUPPORTSPROTECTED

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSurfaceProtectedCapabilitiesKHR(long address, ByteBuffer container)

public
VkSurfaceProtectedCapabilitiesKHR(ByteBuffer container)

Creates a VkSurfaceProtectedCapabilitiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSurfaceProtectedCapabilitiesKHR
calloc()

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with memCalloc.

public static VkSurfaceProtectedCapabilitiesKHR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with memCalloc.

public static VkSurfaceProtectedCapabilitiesKHR
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkSurfaceProtectedCapabilitiesKHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkSurfaceProtectedCapabilitiesKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSurfaceProtectedCapabilitiesKHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSurfaceProtectedCapabilitiesKHR
create()

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with BufferUtils.

public static VkSurfaceProtectedCapabilitiesKHR
create(long address)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance for the specified memory address.

public static VkSurfaceProtectedCapabilitiesKHR.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkSurfaceProtectedCapabilitiesKHR.Buffer instance at the specified memory.

public static VkSurfaceProtectedCapabilitiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSurfaceProtectedCapabilitiesKHR
malloc()

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with memAlloc.

public static VkSurfaceProtectedCapabilitiesKHR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with memAlloc.

public static VkSurfaceProtectedCapabilitiesKHR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated on the specified MemoryStack.

public static VkSurfaceProtectedCapabilitiesKHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkSurfaceProtectedCapabilitiesKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSurfaceProtectedCapabilitiesKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nsupportsProtected(long struct)

Unsafe version of supportsProtected.

public static void
nsupportsProtected(long struct, int value)

Unsafe version of supportsProtected.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSurfaceProtectedCapabilitiesKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkSurfaceProtectedCapabilitiesKHR

Returns:

this struct
set(VkSurfaceProtectedCapabilitiesKHR
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkSurfaceProtectedCapabilitiesKHR
sType(int value)

Sets the specified value to the sType field.

public VkSurfaceProtectedCapabilitiesKHR
sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the sType field.

public boolean
supportsProtected()

specifies whether a protected swapchain created from VkPhysicalDeviceSurfaceInfo2KHR::surface for a particular windowing system can be displayed on screen or not.

public VkSurfaceProtectedCapabilitiesKHR
supportsProtected(boolean value)

Sets the specified value to the supportsProtected field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

SUPPORTSPROTECTEDback to summary
public static final int SUPPORTSPROTECTED

The struct member offsets.

Constructor Detail

VkSurfaceProtectedCapabilitiesKHRback to summary
protected VkSurfaceProtectedCapabilitiesKHR(long address, ByteBuffer container)
VkSurfaceProtectedCapabilitiesKHRback to summary
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 Detail

callocback to summary
public static VkSurfaceProtectedCapabilitiesKHR calloc()

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

callocback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkSurfaceProtectedCapabilitiesKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSurfaceProtectedCapabilitiesKHR create()

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated with BufferUtils.

createback to summary
public static VkSurfaceProtectedCapabilitiesKHR create(long address)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance for the specified memory address.

createback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer create(int capacity)

Returns a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSurfaceProtectedCapabilitiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSurfaceProtectedCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSurfaceProtectedCapabilitiesKHR malloc()

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

mallocback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSurfaceProtectedCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkSurfaceProtectedCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSurfaceProtectedCapabilitiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nsupportsProtectedback to summary
public static int nsupportsProtected(long struct)

Unsafe version of supportsProtected.

nsupportsProtectedback to summary
public static void nsupportsProtected(long struct, int value)

Unsafe version of supportsProtected.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkSurfaceProtectedCapabilitiesKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkSurfaceProtectedCapabilitiesKHR set(VkSurfaceProtectedCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSurfaceProtectedCapabilitiesKHR

the source struct

Returns:VkSurfaceProtectedCapabilitiesKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSurfaceProtectedCapabilitiesKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkSurfaceProtectedCapabilitiesKHR sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the sType field.

supportsProtectedback to summary
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.

Annotations
@NativeType:VkBool32
supportsProtectedback to summary
public VkSurfaceProtectedCapabilitiesKHR supportsProtected(boolean value)

Sets the specified value to the supportsProtected field.

org.lwjgl.vulkan back to summary

public Class VkSurfaceProtectedCapabilitiesKHR.Buffer

extends StructBuffer<VkSurfaceProtectedCapabilitiesKHR, VkSurfaceProtectedCapabilitiesKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkSurfaceProtectedCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSurfaceProtectedCapabilitiesKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkSurfaceProtectedCapabilitiesKHR
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkSurfaceProtectedCapabilitiesKHR#pNext field.
pNext()

public VkSurfaceProtectedCapabilitiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#pNext field.

protected VkSurfaceProtectedCapabilitiesKHR.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkSurfaceProtectedCapabilitiesKHR#sType field.
sType()

public VkSurfaceProtectedCapabilitiesKHR.Buffer
sType(int value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#sType field.

public VkSurfaceProtectedCapabilitiesKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the VkSurfaceProtectedCapabilitiesKHR#sType field.

public boolean

Returns:

the value of the VkSurfaceProtectedCapabilitiesKHR#supportsProtected field.
supportsProtected()

public VkSurfaceProtectedCapabilitiesKHR.Buffer
supportsProtected(boolean value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#supportsProtected field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSurfaceProtectedCapabilitiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSurfaceProtectedCapabilitiesKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSurfaceProtectedCapabilitiesKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkSurfaceProtectedCapabilitiesKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSurfaceProtectedCapabilitiesKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkSurfaceProtectedCapabilitiesKHR.Buffer pNext(long value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#pNext field.

selfback to summary
protected VkSurfaceProtectedCapabilitiesKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkSurfaceProtectedCapabilitiesKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSurfaceProtectedCapabilitiesKHR.Buffer sType(int value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#sType field.

sType$Defaultback to summary
public VkSurfaceProtectedCapabilitiesKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SURFACE_PROTECTED_CAPABILITIES_KHR value to the VkSurfaceProtectedCapabilitiesKHR#sType field.

supportsProtectedback to summary
public boolean supportsProtected()
Returns:boolean

the value of the VkSurfaceProtectedCapabilitiesKHR#supportsProtected field.

Annotations
@NativeType:VkBool32
supportsProtectedback to summary
public VkSurfaceProtectedCapabilitiesKHR.Buffer supportsProtected(boolean value)

Sets the specified value to the VkSurfaceProtectedCapabilitiesKHR#supportsProtected field.