Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMemoryWin32HandleInfoNV

extends Struct<VkExportMemoryWin32HandleInfoNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*, org.lwjgl.system.windows.*

Specify security attributes and access rights for Win32 memory handles.
Description

If this structure is not present, or if pAttributes is set to 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”1. 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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DWACCESS

The struct member offsets.

public static final int
PATTRIBUTES

The struct member offsets.

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkExportMemoryWin32HandleInfoNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMemoryWin32HandleInfoNV
calloc()

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with memCalloc.

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

Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExportMemoryWin32HandleInfoNV
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkExportMemoryWin32HandleInfoNV
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 VkExportMemoryWin32HandleInfoNV
create()

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with BufferUtils.

public static VkExportMemoryWin32HandleInfoNV
create(long address)

Returns a new VkExportMemoryWin32HandleInfoNV instance for the specified memory address.

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

Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.

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

Create a VkExportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.

public static VkExportMemoryWin32HandleInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
dwAccess()

a DWORD specifying access rights of the handle.

public VkExportMemoryWin32HandleInfoNV
dwAccess(int value)

Sets the specified value to the dwAccess field.

public static VkExportMemoryWin32HandleInfoNV
malloc()

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with memAlloc.

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

Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.

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

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

public static VkExportMemoryWin32HandleInfoNV
mallocStack()

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

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

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

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

Unsafe version of dwAccess.

public static void
ndwAccess(long struct, int value)

Unsafe version of dwAccess.

public static SECURITY_ATTRIBUTES
npAttributes(long struct)

Unsafe version of pAttributes.

public static void
npAttributes(long struct, SECURITY_ATTRIBUTES value)

Unsafe version of pAttributes.

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 SECURITY_ATTRIBUTES
pAttributes()

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

public VkExportMemoryWin32HandleInfoNV
pAttributes(SECURITY_ATTRIBUTES value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkExportMemoryWin32HandleInfoNV
pNext(long value)

Sets the specified value to the pNext field.

public VkExportMemoryWin32HandleInfoNV
set(int sType, long pNext, SECURITY_ATTRIBUTES pAttributes, int dwAccess)

Initializes this struct with the specified values.

public VkExportMemoryWin32HandleInfoNV

Returns:

this struct
set
(VkExportMemoryWin32HandleInfoNV
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 VkExportMemoryWin32HandleInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkExportMemoryWin32HandleInfoNV
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

DWACCESSback to summary
public static final int DWACCESS

The struct member offsets.

PATTRIBUTESback to summary
public static final int PATTRIBUTES

The struct member offsets.

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.

Constructor Detail

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

callocback to summary
public static VkExportMemoryWin32HandleInfoNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMemoryWin32HandleInfoNV calloc(MemoryStack stack)

Returns a new VkExportMemoryWin32HandleInfoNV 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 VkExportMemoryWin32HandleInfoNV.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExportMemoryWin32HandleInfoNV.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 VkExportMemoryWin32HandleInfoNV 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 VkExportMemoryWin32HandleInfoNV create()

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated with BufferUtils.

createback to summary
public static VkExportMemoryWin32HandleInfoNV create(long address)

Returns a new VkExportMemoryWin32HandleInfoNV instance for the specified memory address.

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

Returns a new VkExportMemoryWin32HandleInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMemoryWin32HandleInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMemoryWin32HandleInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dwAccessback to summary
public int dwAccess()

a DWORD specifying access rights of the handle.

Annotations
@NativeType:DWORD
dwAccessback to summary
public VkExportMemoryWin32HandleInfoNV dwAccess(int value)

Sets the specified value to the dwAccess field.

mallocback to summary
public static VkExportMemoryWin32HandleInfoNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMemoryWin32HandleInfoNV malloc(MemoryStack stack)

Returns a new VkExportMemoryWin32HandleInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndwAccessback to summary
public static int ndwAccess(long struct)

Unsafe version of dwAccess.

ndwAccessback to summary
public static void ndwAccess(long struct, int value)

Unsafe version of dwAccess.

npAttributesback to summary
public static SECURITY_ATTRIBUTES npAttributes(long struct)

Unsafe version of pAttributes.

Annotations
@Nullable
npAttributesback to summary
public static void npAttributes(long struct, SECURITY_ATTRIBUTES value)

Unsafe version of pAttributes.

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.

pAttributesback to summary
public SECURITY_ATTRIBUTES pAttributes()

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

Annotations
@Nullable
@NativeType:SECURITY_ATTRIBUTES const *
pAttributesback to summary
public VkExportMemoryWin32HandleInfoNV pAttributes(SECURITY_ATTRIBUTES value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkExportMemoryWin32HandleInfoNV set(int sType, long pNext, SECURITY_ATTRIBUTES pAttributes, int dwAccess)

Initializes this struct with the specified values.

setback to summary
public VkExportMemoryWin32HandleInfoNV set(VkExportMemoryWin32HandleInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMemoryWin32HandleInfoNV

the source struct

Returns:VkExportMemoryWin32HandleInfoNV

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 VkExportMemoryWin32HandleInfoNV sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkExportMemoryWin32HandleInfoNV.Buffer

extends StructBuffer<VkExportMemoryWin32HandleInfoNV, VkExportMemoryWin32HandleInfoNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkExportMemoryWin32HandleInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMemoryWin32HandleInfoNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExportMemoryWin32HandleInfoNV.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
public int

Returns:

the value of the VkExportMemoryWin32HandleInfoNV#dwAccess field.
dwAccess
()

public VkExportMemoryWin32HandleInfoNV.Buffer
dwAccess(int value)

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#dwAccess field.

protected VkExportMemoryWin32HandleInfoNV
public SECURITY_ATTRIBUTES

Returns:

a SECURITY_ATTRIBUTES view of the struct pointed to by the VkExportMemoryWin32HandleInfoNV#pAttributes field.
pAttributes
()

public VkExportMemoryWin32HandleInfoNV.Buffer
public long

Returns:

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

public VkExportMemoryWin32HandleInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#pNext field.

protected VkExportMemoryWin32HandleInfoNV.Buffer
public int

Returns:

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

public VkExportMemoryWin32HandleInfoNV.Buffer
sType(int value)

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#sType field.

public VkExportMemoryWin32HandleInfoNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMemoryWin32HandleInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExportMemoryWin32HandleInfoNV.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 VkExportMemoryWin32HandleInfoNV#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

dwAccessback to summary
public int dwAccess()
Returns:int

the value of the VkExportMemoryWin32HandleInfoNV#dwAccess field.

Annotations
@NativeType:DWORD
dwAccessback to summary
public VkExportMemoryWin32HandleInfoNV.Buffer dwAccess(int value)

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#dwAccess field.

getElementFactoryback to summary
protected VkExportMemoryWin32HandleInfoNV getElementFactory()

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

Annotations
@Override
pAttributesback to summary
public SECURITY_ATTRIBUTES pAttributes()
Returns:SECURITY_ATTRIBUTES

a SECURITY_ATTRIBUTES view of the struct pointed to by the VkExportMemoryWin32HandleInfoNV#pAttributes field.

Annotations
@Nullable
@NativeType:SECURITY_ATTRIBUTES const *
pAttributesback to summary
public VkExportMemoryWin32HandleInfoNV.Buffer pAttributes(SECURITY_ATTRIBUTES value)

Sets the address of the specified SECURITY_ATTRIBUTES to the VkExportMemoryWin32HandleInfoNV#pAttributes field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMemoryWin32HandleInfoNV#pNext field.

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

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#pNext field.

selfback to summary
protected VkExportMemoryWin32HandleInfoNV.Buffer self()

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

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

the value of the VkExportMemoryWin32HandleInfoNV#sType field.

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

Sets the specified value to the VkExportMemoryWin32HandleInfoNV#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV value to the VkExportMemoryWin32HandleInfoNV#sType field.