Package org.lwjgl.vulkan
Class VkFenceGetWin32HandleInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkFenceGetWin32HandleInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkFenceGetWin32HandleInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure describing a Win32 handle fence export operation.Description
The properties of the handle returned depend on the value of
handleType. SeeVkExternalFenceHandleTypeFlagBitsfor 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
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.fence– the fence from which state will be exported.handleType– the type of handle requested.
Layout
struct VkFenceGetWin32HandleInfoKHR { VkStructureType sType; void const * pNext; VkFence fence; VkExternalFenceHandleTypeFlagBits handleType; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkFenceGetWin32HandleInfoKHR.BufferAn array ofVkFenceGetWin32HandleInfoKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)Creates aVkFenceGetWin32HandleInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkFenceGetWin32HandleInfoKHRcalloc()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemCalloc.static VkFenceGetWin32HandleInfoKHR.Buffercalloc(int capacity)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc.static VkFenceGetWin32HandleInfoKHRcallocStack()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR.BuffercallocStack(int capacity)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHRcreate()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withBufferUtils.static VkFenceGetWin32HandleInfoKHR.Buffercreate(int capacity)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.static VkFenceGetWin32HandleInfoKHRcreate(long address)Returns a newVkFenceGetWin32HandleInfoKHRinstance for the specified memory address.static VkFenceGetWin32HandleInfoKHR.Buffercreate(long address, int capacity)Create aVkFenceGetWin32HandleInfoKHR.Bufferinstance at the specified memory.static VkFenceGetWin32HandleInfoKHRcreateSafe(long address)static VkFenceGetWin32HandleInfoKHR.BuffercreateSafe(long address, int capacity)longfence()Returns the value of thefencefield.VkFenceGetWin32HandleInfoKHRfence(long value)Sets the specified value to thefencefield.inthandleType()Returns the value of thehandleTypefield.VkFenceGetWin32HandleInfoKHRhandleType(int value)Sets the specified value to thehandleTypefield.static VkFenceGetWin32HandleInfoKHRmalloc()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemAlloc.static VkFenceGetWin32HandleInfoKHR.Buffermalloc(int capacity)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc.static VkFenceGetWin32HandleInfoKHRmallocStack()Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.static VkFenceGetWin32HandleInfoKHR.BuffermallocStack(int capacity)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkFenceGetWin32HandleInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkFenceGetWin32HandleInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.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()Returns the value of thepNextfield.VkFenceGetWin32HandleInfoKHRpNext(long value)Sets the specified value to thepNextfield.VkFenceGetWin32HandleInfoKHRset(int sType, long pNext, long fence, int handleType)Initializes this struct with the specified values.VkFenceGetWin32HandleInfoKHRset(VkFenceGetWin32HandleInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkFenceGetWin32HandleInfoKHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkFenceGetWin32HandleInfoKHR
public VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
fence
public long fence()
Returns the value of thefencefield.
-
handleType
public int handleType()
Returns the value of thehandleTypefield.
-
sType
public VkFenceGetWin32HandleInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkFenceGetWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
fence
public VkFenceGetWin32HandleInfoKHR fence(long value)
Sets the specified value to thefencefield.
-
handleType
public VkFenceGetWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleTypefield.
-
set
public VkFenceGetWin32HandleInfoKHR set(int sType, long pNext, long fence, int handleType)
Initializes this struct with the specified values.
-
set
public VkFenceGetWin32HandleInfoKHR set(VkFenceGetWin32HandleInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkFenceGetWin32HandleInfoKHR malloc()
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkFenceGetWin32HandleInfoKHR calloc()
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkFenceGetWin32HandleInfoKHR create()
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated withBufferUtils.
-
create
public static VkFenceGetWin32HandleInfoKHR create(long address)
Returns a newVkFenceGetWin32HandleInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkFenceGetWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkFenceGetWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkFenceGetWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkFenceGetWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkFenceGetWin32HandleInfoKHR.Buffer create(long address, int capacity)
Create aVkFenceGetWin32HandleInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkFenceGetWin32HandleInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkFenceGetWin32HandleInfoKHR mallocStack()
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkFenceGetWin32HandleInfoKHR callocStack()
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkFenceGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkFenceGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkFenceGetWin32HandleInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkFenceGetWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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.
-
-