Package org.lwjgl.vulkan
Class VkImportFenceWin32HandleInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImportFenceWin32HandleInfoKHR>
org.lwjgl.vulkan.VkImportFenceWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkImportFenceWin32HandleInfoKHR
extends Struct<VkImportFenceWin32HandleInfoKHR>
implements NativeResource
(None).
Handle Types Supported by
Description
The handle types supported by handleType
are:
Handle Types Supported by VkImportFenceWin32HandleInfoKHR
Handle Type | Transference | Permanence Supported |
---|---|---|
EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT | Reference | Temporary,Permanent |
EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT | Reference | Temporary,Permanent |
Valid Usage
handleType
must be a value included in the Handle Types Supported byVkImportFenceWin32HandleInfoKHR
table- If
handleType
is notEXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT
,name
must beNULL
- If
handle
isNULL
,name
must name a valid synchronization primitive of the type specified byhandleType
- If
name
isNULL
,handle
must be a valid handle of the type specified byhandleType
- If
handle
is notNULL
,name
must beNULL
- If
handle
is notNULL
, it must obey any requirements listed forhandleType
in external fence handle types compatibility - If
name
is notNULL
, it must obey any requirements listed forhandleType
in external fence handle types compatibility
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
pNext
must beNULL
fence
must be a validVkFence
handleflags
must be a valid combination ofVkFenceImportFlagBits
values
Host Synchronization
- Host access to
fence
must be externally synchronized
See Also
Layout
struct VkImportFenceWin32HandleInfoKHR {
VkStructureType sType()
;
void const * pNext()
;
VkFence fence()
;
VkFenceImportFlags flags()
;
VkExternalFenceHandleTypeFlagBits handleType()
;
HANDLE handle()
;
LPCWSTR name()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkImportFenceWin32HandleInfoKHR
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkImportFenceWin32HandleInfoKHR
(ByteBuffer container) Creates aVkImportFenceWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkImportFenceWin32HandleInfoKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkImportFenceWin32HandleInfoKHR.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) long
fence()
the fence into which the state will be imported.fence
(long value) Sets the specified value to thefence()
field.int
flags()
a bitmask ofVkFenceImportFlagBits
specifying additional parameters for the fence payload import operation.flags
(int value) Sets the specified value to theflags()
field.long
handle()
NULL
or the external handle to import.handle
(long value) Sets the specified value to thehandle()
field.int
aVkExternalFenceHandleTypeFlagBits
value specifying the type ofhandle
.handleType
(int value) Sets the specified value to thehandleType()
field.malloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.name()
NULL
or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.name
(ByteBuffer value) Sets the address of the specified encoded string to thename()
field.NULL
or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.static long
nfence
(long struct) Unsafe version offence()
.static void
nfence
(long struct, long value) Unsafe version offence
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static long
nhandle
(long struct) Unsafe version ofhandle()
.static void
nhandle
(long struct, long value) Unsafe version ofhandle
.static int
nhandleType
(long struct) Unsafe version ofhandleType()
.static void
nhandleType
(long struct, int value) Unsafe version ofhandleType
.static ByteBuffer
nname
(long struct) Unsafe version ofname()
.static void
nname
(long struct, ByteBuffer value) Unsafe version ofname
.static String
nnameString
(long struct) Unsafe version ofnameString()
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, long fence, int flags, int handleType, long handle, ByteBuffer name) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
value to thesType()
field.static void
validate
(long struct) Validates pointer members that should not beNULL
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FENCE
public static final int FENCEThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets. -
HANDLE
public static final int HANDLEThe struct member offsets. -
NAME
public static final int NAMEThe struct member offsets.
-
-
Constructor Details
-
VkImportFenceWin32HandleInfoKHR
Creates aVkImportFenceWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkImportFenceWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
fence
public long fence()the fence into which the state will be imported. -
flags
public int flags()a bitmask ofVkFenceImportFlagBits
specifying additional parameters for the fence payload import operation. -
handleType
public int handleType()aVkExternalFenceHandleTypeFlagBits
value specifying the type ofhandle
. -
handle
public long handle()NULL
or the external handle to import. -
name
NULL
or a null-terminated UTF-16 string naming the underlying synchronization primitive to import. -
nameString
NULL
or a null-terminated UTF-16 string naming the underlying synchronization primitive to import. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
fence
Sets the specified value to thefence()
field. -
flags
Sets the specified value to theflags()
field. -
handleType
Sets the specified value to thehandleType()
field. -
handle
Sets the specified value to thehandle()
field. -
name
Sets the address of the specified encoded string to thename()
field. -
set
public VkImportFenceWin32HandleInfoKHR set(int sType, long pNext, long fence, int flags, int handleType, long handle, ByteBuffer name) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
. -
create
Returns a newVkImportFenceWin32HandleInfoKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkImportFenceWin32HandleInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkImportFenceWin32HandleInfoKHR.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nfence
public static long nfence(long struct) Unsafe version offence()
. -
nflags
public static int nflags(long struct) Unsafe version offlags()
. -
nhandleType
public static int nhandleType(long struct) Unsafe version ofhandleType()
. -
nhandle
public static long nhandle(long struct) Unsafe version ofhandle()
. -
nname
Unsafe version ofname()
. -
nnameString
Unsafe version ofnameString()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nfence
public static void nfence(long struct, long value) Unsafe version offence
. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags
. -
nhandleType
public static void nhandleType(long struct, int value) Unsafe version ofhandleType
. -
nhandle
public static void nhandle(long struct, long value) Unsafe version ofhandle
. -
nname
Unsafe version ofname
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-