Package org.lwjgl.vulkan
Class VkFenceGetWin32HandleInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkFenceGetWin32HandleInfoKHR>
org.lwjgl.vulkan.VkFenceGetWin32HandleInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkFenceGetWin32HandleInfoKHR
extends org.lwjgl.system.Struct<VkFenceGetWin32HandleInfoKHR>
implements org.lwjgl.system.NativeResource
Structure describing a Win32 handle fence export operation.
Description
The properties of the handle returned depend on the value of handleType. See VkExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.
Valid Usage
handleTypemust have been included inVkExportFenceCreateInfo::handleTypeswhen thefence’s current payload was created- If
handleTypeis defined as an NT handle,GetFenceWin32HandleKHRmust be called no more than once for each valid unique combination offenceandhandleType fencemust not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included inVkExternalFenceProperties::exportFromImportedHandleTypesforhandleType- If
handleTyperefers to a handle type with copy payload transference semantics,fencemust be signaled, or have an associated fence signal operation pending execution handleTypemust be defined as an NT handle or a global share handle
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHRpNextmust beNULLfencemust be a validVkFencehandlehandleTypemust be a validVkExternalFenceHandleTypeFlagBitsvalue
See Also
Layout
struct VkFenceGetWin32HandleInfoKHR {
VkStructureType sType();
void const * pNext();
VkFence fence();
VkExternalFenceHandleTypeFlagBits handleType();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkFenceGetWin32HandleInfoKHR(ByteBuffer container) Creates aVkFenceGetWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkFenceGetWin32HandleInfoKHRcalloc()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkFenceGetWin32HandleInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkFenceGetWin32HandleInfoKHRcreate()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.static VkFenceGetWin32HandleInfoKHRcreate(long address) Returns a newVkFenceGetWin32HandleInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkFenceGetWin32HandleInfoKHR.Bufferinstance at the specified memory.static @Nullable VkFenceGetWin32HandleInfoKHRcreateSafe(long address) static @Nullable VkFenceGetWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity) longfence()the fence from which state will be exported.fence(long value) Sets the specified value to thefence()field.intaVkExternalFenceHandleTypeFlagBitsvalue specifying the type of handle requested.handleType(int value) Sets the specified value to thehandleType()field.static VkFenceGetWin32HandleInfoKHRmalloc()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkFenceGetWin32HandleInfoKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.static VkFenceGetWin32HandleInfoKHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkFenceGetWin32HandleInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static longnfence(long struct) Unsafe version offence().static voidnfence(long struct, long value) Unsafe version offence.static intnhandleType(long struct) Unsafe version ofhandleType().static voidnhandleType(long struct, int value) Unsafe version ofhandleType.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor 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 handleType) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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. -
HANDLETYPE
public static final int HANDLETYPEThe struct member offsets.
-
-
Constructor Details
-
VkFenceGetWin32HandleInfoKHR
Creates aVkFenceGetWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkFenceGetWin32HandleInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
fence
public long fence()the fence from which state will be exported. -
handleType
public int handleType()aVkExternalFenceHandleTypeFlagBitsvalue specifying the type of handle requested. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
fence
Sets the specified value to thefence()field. -
handleType
Sets the specified value to thehandleType()field. -
set
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 newVkFenceGetWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkFenceGetWin32HandleInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkFenceGetWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
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 public static VkFenceGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkFenceGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack) 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 VkFenceGetWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkFenceGetWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkFenceGetWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand 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(). -
nhandleType
public static int nhandleType(long struct) Unsafe version ofhandleType(). -
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. -
nhandleType
public static void nhandleType(long struct, int value) Unsafe version ofhandleType.
-