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.NativeResource
Structure describing a Win32 handle fence export operation.Description
The properties of the handle returned depend on the value of
handleType
. SeeVkExternalFenceHandleTypeFlagBits
for a description of the properties of the defined external fence handle types.Valid Usage
handleType
must have been included inVkExportFenceCreateInfo
::handleTypes
when thefence
’s current payload was created.- If
handleType
is defined as an NT handle,GetFenceWin32HandleKHR
must be called no more than once for each valid unique combination offence
andhandleType
. fence
must 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
::exportFromImportedHandleTypes
forhandleType
.- If
handleType
refers to a handle type with copy payload transference semantics,fence
must be signaled, or have an associated fence signal operation pending execution. handleType
must be defined as an NT handle or a global share handle.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_FENCE_GET_WIN32_HANDLE_INFO_KHR
pNext
must beNULL
fence
must be a validVkFence
handlehandleType
must be a validVkExternalFenceHandleTypeFlagBits
value
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or 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 class
VkFenceGetWin32HandleInfoKHR.Buffer
An array ofVkFenceGetWin32HandleInfoKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkFenceGetWin32HandleInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkFenceGetWin32HandleInfoKHR
calloc()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated withmemCalloc
.static VkFenceGetWin32HandleInfoKHR.Buffer
calloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.static VkFenceGetWin32HandleInfoKHR
callocStack()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkFenceGetWin32HandleInfoKHR
create()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated withBufferUtils
.static VkFenceGetWin32HandleInfoKHR.Buffer
create(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.static VkFenceGetWin32HandleInfoKHR
create(long address)
Returns a newVkFenceGetWin32HandleInfoKHR
instance for the specified memory address.static VkFenceGetWin32HandleInfoKHR.Buffer
create(long address, int capacity)
Create aVkFenceGetWin32HandleInfoKHR.Buffer
instance at the specified memory.static VkFenceGetWin32HandleInfoKHR
createSafe(long address)
static VkFenceGetWin32HandleInfoKHR.Buffer
createSafe(long address, int capacity)
long
fence()
Returns the value of thefence
field.VkFenceGetWin32HandleInfoKHR
fence(long value)
Sets the specified value to thefence
field.int
handleType()
Returns the value of thehandleType
field.VkFenceGetWin32HandleInfoKHR
handleType(int value)
Sets the specified value to thehandleType
field.static VkFenceGetWin32HandleInfoKHR
malloc()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated withmemAlloc
.static VkFenceGetWin32HandleInfoKHR.Buffer
malloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.static VkFenceGetWin32HandleInfoKHR
mallocStack()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.static VkFenceGetWin32HandleInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkFenceGetWin32HandleInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkFenceGetWin32HandleInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.static long
nfence(long struct)
Unsafe version offence()
.static void
nfence(long struct, long value)
Unsafe version offence
.static int
nhandleType(long struct)
Unsafe version ofhandleType()
.static void
nhandleType(long struct, int value)
Unsafe version ofhandleType
.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()
Returns the value of thepNext
field.VkFenceGetWin32HandleInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.VkFenceGetWin32HandleInfoKHR
set(int sType, long pNext, long fence, int handleType)
Initializes this struct with the specified values.VkFenceGetWin32HandleInfoKHR
set(VkFenceGetWin32HandleInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkFenceGetWin32HandleInfoKHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkFenceGetWin32HandleInfoKHR
public VkFenceGetWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkFenceGetWin32HandleInfoKHR
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
fence
public long fence()
Returns the value of thefence
field.
-
handleType
public int handleType()
Returns the value of thehandleType
field.
-
sType
public VkFenceGetWin32HandleInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkFenceGetWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
fence
public VkFenceGetWin32HandleInfoKHR fence(long value)
Sets the specified value to thefence
field.
-
handleType
public VkFenceGetWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleType
field.
-
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 newVkFenceGetWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkFenceGetWin32HandleInfoKHR calloc()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkFenceGetWin32HandleInfoKHR create()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkFenceGetWin32HandleInfoKHR create(long address)
Returns a newVkFenceGetWin32HandleInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkFenceGetWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkFenceGetWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkFenceGetWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFenceGetWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkFenceGetWin32HandleInfoKHR.Buffer create(long address, int capacity)
Create aVkFenceGetWin32HandleInfoKHR.Buffer
instance 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 newVkFenceGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkFenceGetWin32HandleInfoKHR callocStack()
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkFenceGetWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkFenceGetWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkFenceGetWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkFenceGetWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkFenceGetWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-