Package org.lwjgl.vulkan

Class VkExportMemoryWin32HandleInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportMemoryWin32HandleInfoNV>

org.lwjgl.vulkan.VkExportMemoryWin32HandleInfoNV

All Implemented Interfaces:

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

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

Specify security attributes and access rights for Win32 memory handles.

Description

If this structure is not present, or if pAttributes is NULL, default security descriptor values will be used, and child processes created by the application will not inherit the handle, as described in the MSDN documentation for “Synchronization Object Security and Access Rights”¹. Further, if the structure is not present, the access rights will be

DXGI_SHARED_RESOURCE_READ | DXGI_SHARED_RESOURCE_WRITE

1

https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV
• If pAttributes is not NULL, pAttributes must be a valid pointer to a valid SECURITY_ATTRIBUTES value

Layout

 struct VkExportMemoryWin32HandleInfoNV {
     VkStructureType sType();
     void const * pNext();
     SECURITY_ATTRIBUTES const * pAttributes();
     DWORD dwAccess();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkExportMemoryWin32HandleInfoNV	calloc()	Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with memCalloc.
static VkExportMemoryWin32HandleInfoNV.Buffer	calloc(int capacity)	Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with memCalloc.
static VkExportMemoryWin32HandleInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMemoryWin32HandleInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMemoryWin32HandleInfoNV	callocStack()	Deprecated.
static VkExportMemoryWin32HandleInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkExportMemoryWin32HandleInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportMemoryWin32HandleInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportMemoryWin32HandleInfoNV	create()	Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with BufferUtils.
static VkExportMemoryWin32HandleInfoNV.Buffer	create(int capacity)	Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.
static VkExportMemoryWin32HandleInfoNV	create(long address)	Returns a new VkExportMemoryWin32HandleInfoNV instance for the specified memory address.
static VkExportMemoryWin32HandleInfoNV.Buffer	create(long address, int capacity)	Create a VkExportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.
static @Nullable VkExportMemoryWin32HandleInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExportMemoryWin32HandleInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	dwAccess()	a DWORD specifying access rights of the handle.
VkExportMemoryWin32HandleInfoNV	dwAccess(int value)	Sets the specified value to the dwAccess() field.
static VkExportMemoryWin32HandleInfoNV	malloc()	Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with memAlloc.
static VkExportMemoryWin32HandleInfoNV.Buffer	malloc(int capacity)	Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with memAlloc.
static VkExportMemoryWin32HandleInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkExportMemoryWin32HandleInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.
static VkExportMemoryWin32HandleInfoNV	mallocStack()	Deprecated.
static VkExportMemoryWin32HandleInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkExportMemoryWin32HandleInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportMemoryWin32HandleInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ndwAccess(long struct)	Unsafe version of dwAccess().
static void	ndwAccess(long struct, int value)	Unsafe version of dwAccess.
static @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES	npAttributes(long struct)	Unsafe version of pAttributes().
static void	npAttributes(long struct, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)	Unsafe version of pAttributes.
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.
@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES	pAttributes()	a pointer to a Windows SECURITY_ATTRIBUTES structure specifying security attributes of the handle.
VkExportMemoryWin32HandleInfoNV	pAttributes(@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)	Sets the address of the specified SECURITY_ATTRIBUTES to the pAttributes() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkExportMemoryWin32HandleInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkExportMemoryWin32HandleInfoNV	set(int sType, long pNext, @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes, int dwAccess)	Initializes this struct with the specified values.
VkExportMemoryWin32HandleInfoNV	set(VkExportMemoryWin32HandleInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExportMemoryWin32HandleInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkExportMemoryWin32HandleInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV 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.

PATTRIBUTES

public static final int PATTRIBUTES

The struct member offsets.

DWACCESS

public static final int DWACCESS

The struct member offsets.

Constructor Details

VkExportMemoryWin32HandleInfoNV

public VkExportMemoryWin32HandleInfoNV(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pAttributes

public @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes()

a pointer to a Windows SECURITY_ATTRIBUTES structure specifying security attributes of the handle.

dwAccess

public int dwAccess()

a DWORD specifying access rights of the handle.

sType

public VkExportMemoryWin32HandleInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportMemoryWin32HandleInfoNV sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV value to the sType() field.

pNext

public VkExportMemoryWin32HandleInfoNV pNext(long value)

Sets the specified value to the pNext() field.

pAttributes

public VkExportMemoryWin32HandleInfoNV pAttributes(@Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)

Sets the address of the specified SECURITY_ATTRIBUTES to the pAttributes() field.

dwAccess

public VkExportMemoryWin32HandleInfoNV dwAccess(int value)

Sets the specified value to the dwAccess() field.

set

public VkExportMemoryWin32HandleInfoNV set(int sType,
 long pNext,
 @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES pAttributes,
 int dwAccess)

Initializes this struct with the specified values.

set

public VkExportMemoryWin32HandleInfoNV set(VkExportMemoryWin32HandleInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportMemoryWin32HandleInfoNV malloc()

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

calloc

public static VkExportMemoryWin32HandleInfoNV calloc()

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

create

public static VkExportMemoryWin32HandleInfoNV create()

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with BufferUtils.

create

public static VkExportMemoryWin32HandleInfoNV create(long address)

Returns a new VkExportMemoryWin32HandleInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkExportMemoryWin32HandleInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportMemoryWin32HandleInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExportMemoryWin32HandleInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExportMemoryWin32HandleInfoNV.Buffer create(int capacity)

Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExportMemoryWin32HandleInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkExportMemoryWin32HandleInfoNV callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npAttributes

public static @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES npAttributes(long struct)

Unsafe version of pAttributes().

ndwAccess

public static int ndwAccess(long struct)

Unsafe version of dwAccess().

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.

npAttributes

public static void npAttributes(long struct,
 @Nullable org.lwjgl.system.windows.SECURITY_ATTRIBUTES value)

Unsafe version of pAttributes.

ndwAccess

public static void ndwAccess(long struct,
 int value)

Unsafe version of dwAccess.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate