Package org.lwjgl.vulkan

Class VkPhysicalDeviceProtectedMemoryProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceProtectedMemoryProperties>

org.lwjgl.vulkan.VkPhysicalDeviceProtectedMemoryProperties

All Implemented Interfaces:

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

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

Structure describing protected memory properties that can be supported by an implementation.

Description

If the VkPhysicalDeviceProtectedMemoryProperties structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_PROTECTED_MEMORY_PROPERTIES

Layout

 struct VkPhysicalDeviceProtectedMemoryProperties {
     VkStructureType sType();
     void * pNext();
     VkBool32 protectedNoFault();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceProtectedMemoryProperties.Buffer	An array of VkPhysicalDeviceProtectedMemoryProperties 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	PNEXT	The struct member offsets.
static final int	PROTECTEDNOFAULT	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
VkPhysicalDeviceProtectedMemoryProperties(ByteBuffer container)	Creates a VkPhysicalDeviceProtectedMemoryProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceProtectedMemoryProperties	calloc()	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated with memCalloc.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceProtectedMemoryProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceProtectedMemoryProperties	callocStack()	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties	create()	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated with BufferUtils.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceProtectedMemoryProperties	create(long address)	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance for the specified memory address.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceProtectedMemoryProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceProtectedMemoryProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceProtectedMemoryProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceProtectedMemoryProperties	malloc()	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated with memAlloc.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceProtectedMemoryProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated on the specified MemoryStack.
static VkPhysicalDeviceProtectedMemoryProperties	mallocStack()	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProtectedMemoryProperties	mallocStack(org.lwjgl.system.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	nprotectedNoFault(long struct)	Unsafe version of protectedNoFault().
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.
VkPhysicalDeviceProtectedMemoryProperties	pNext(long value)	Sets the specified value to the pNext() field.
boolean	protectedNoFault()	specifies how an implementation behaves when an application attempts to write to unprotected memory in a protected queue operation, read from protected memory in an unprotected queue operation, or perform a query in a protected queue operation.
VkPhysicalDeviceProtectedMemoryProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceProtectedMemoryProperties	set(VkPhysicalDeviceProtectedMemoryProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceProtectedMemoryProperties	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceProtectedMemoryProperties	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_PROTECTED_MEMORY_PROPERTIES value to the sType() field.

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.

PROTECTEDNOFAULT

public static final int PROTECTEDNOFAULT

The struct member offsets.

Constructor Details

VkPhysicalDeviceProtectedMemoryProperties

public VkPhysicalDeviceProtectedMemoryProperties(ByteBuffer container)

Creates a VkPhysicalDeviceProtectedMemoryProperties 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<VkPhysicalDeviceProtectedMemoryProperties>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

protectedNoFault

public boolean protectedNoFault()

specifies how an implementation behaves when an application attempts to write to unprotected memory in a protected queue operation, read from protected memory in an unprotected queue operation, or perform a query in a protected queue operation. If this limit is TRUE, such writes will be discarded or have undefined values written, reads and queries will return undefined values. If this limit is FALSE, applications must not perform these operations. See Protected Memory Access Rules for more information.

sType

public VkPhysicalDeviceProtectedMemoryProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceProtectedMemoryProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_PROTECTED_MEMORY_PROPERTIES value to the sType() field.

pNext

public VkPhysicalDeviceProtectedMemoryProperties pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceProtectedMemoryProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceProtectedMemoryProperties set(VkPhysicalDeviceProtectedMemoryProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceProtectedMemoryProperties malloc()

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

calloc

public static VkPhysicalDeviceProtectedMemoryProperties calloc()

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

create

public static VkPhysicalDeviceProtectedMemoryProperties create()

Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceProtectedMemoryProperties create(long address)

Returns a new VkPhysicalDeviceProtectedMemoryProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceProtectedMemoryProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceProtectedMemoryProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceProtectedMemoryProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceProtectedMemoryProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceProtectedMemoryProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceProtectedMemoryProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceProtectedMemoryProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceProtectedMemoryProperties callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceProtectedMemoryProperties.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 VkPhysicalDeviceProtectedMemoryProperties.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 VkPhysicalDeviceProtectedMemoryProperties malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceProtectedMemoryProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nprotectedNoFault

public static int nprotectedNoFault(long struct)

Unsafe version of protectedNoFault().

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.