Package org.lwjgl.vulkan
Class VkImportFenceWin32HandleInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImportFenceWin32HandleInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkImportFenceWin32HandleInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
(None).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 by VkImportFenceWin32HandleInfoKHR table.- If
handleType
is notEXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT
,name
must beNULL
. - If
handleType
is not 0 andhandle
isNULL
,name
must name a valid synchronization primitive of the type specified byhandleType
. - If
handleType
is not 0 andname
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- If
handleType
is not 0,handleType
must be a validVkExternalFenceHandleTypeFlagBits
value
Host Synchronization
- Host access to
fence
must be externally synchronized
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.fence
– the fence into which the state will be imported.flags
– a bitmask ofVkFenceImportFlagBits
specifying additional parameters for the fence payload import operation.handleType
– specifies the type ofhandle
.handle
– the external handle to import, orNULL
.name
– the NULL-terminated UTF-16 string naming the underlying synchronization primitive to import, orNULL
.
Layout
struct VkImportFenceWin32HandleInfoKHR { VkStructureType sType; void const * pNext; VkFence fence; VkFenceImportFlags flags; VkExternalFenceHandleTypeFlagBits handleType; HANDLE handle; LPCWSTR name; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkImportFenceWin32HandleInfoKHR.Buffer
An array ofVkImportFenceWin32HandleInfoKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkImportFenceWin32HandleInfoKHR(java.nio.ByteBuffer container)
Creates aVkImportFenceWin32HandleInfoKHR
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 VkImportFenceWin32HandleInfoKHR
calloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
.static VkImportFenceWin32HandleInfoKHR.Buffer
calloc(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
.static VkImportFenceWin32HandleInfoKHR
callocStack()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImportFenceWin32HandleInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImportFenceWin32HandleInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportFenceWin32HandleInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImportFenceWin32HandleInfoKHR
create()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
.static VkImportFenceWin32HandleInfoKHR.Buffer
create(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.static VkImportFenceWin32HandleInfoKHR
create(long address)
Returns a newVkImportFenceWin32HandleInfoKHR
instance for the specified memory address.static VkImportFenceWin32HandleInfoKHR.Buffer
create(long address, int capacity)
Create aVkImportFenceWin32HandleInfoKHR.Buffer
instance at the specified memory.static VkImportFenceWin32HandleInfoKHR
createSafe(long address)
static VkImportFenceWin32HandleInfoKHR.Buffer
createSafe(long address, int capacity)
long
fence()
Returns the value of thefence
field.VkImportFenceWin32HandleInfoKHR
fence(long value)
Sets the specified value to thefence
field.int
flags()
Returns the value of theflags
field.VkImportFenceWin32HandleInfoKHR
flags(int value)
Sets the specified value to theflags
field.long
handle()
Returns the value of thehandle
field.VkImportFenceWin32HandleInfoKHR
handle(long value)
Sets the specified value to thehandle
field.int
handleType()
Returns the value of thehandleType
field.VkImportFenceWin32HandleInfoKHR
handleType(int value)
Sets the specified value to thehandleType
field.static VkImportFenceWin32HandleInfoKHR
malloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
.static VkImportFenceWin32HandleInfoKHR.Buffer
malloc(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
.static VkImportFenceWin32HandleInfoKHR
mallocStack()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.static VkImportFenceWin32HandleInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkImportFenceWin32HandleInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkImportFenceWin32HandleInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.java.nio.ByteBuffer
name()
Returns aByteBuffer
view of the null-terminated string pointed to by thename
field.VkImportFenceWin32HandleInfoKHR
name(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thename
field.java.lang.String
nameString()
Decodes the null-terminated string pointed to by thename
field.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 java.nio.ByteBuffer
nname(long struct)
Unsafe version ofname()
.static void
nname(long struct, java.nio.ByteBuffer value)
Unsafe version ofname
.static java.lang.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()
Returns the value of thepNext
field.VkImportFenceWin32HandleInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.VkImportFenceWin32HandleInfoKHR
set(int sType, long pNext, long fence, int flags, int handleType, long handle, java.nio.ByteBuffer name)
Initializes this struct with the specified values.VkImportFenceWin32HandleInfoKHR
set(VkImportFenceWin32HandleInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkImportFenceWin32HandleInfoKHR
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkImportFenceWin32HandleInfoKHR
public VkImportFenceWin32HandleInfoKHR(java.nio.ByteBuffer container)
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 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.
-
flags
public int flags()
Returns the value of theflags
field.
-
handleType
public int handleType()
Returns the value of thehandleType
field.
-
handle
public long handle()
Returns the value of thehandle
field.
-
name
public java.nio.ByteBuffer name()
Returns aByteBuffer
view of the null-terminated string pointed to by thename
field.
-
nameString
public java.lang.String nameString()
Decodes the null-terminated string pointed to by thename
field.
-
sType
public VkImportFenceWin32HandleInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkImportFenceWin32HandleInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
fence
public VkImportFenceWin32HandleInfoKHR fence(long value)
Sets the specified value to thefence
field.
-
flags
public VkImportFenceWin32HandleInfoKHR flags(int value)
Sets the specified value to theflags
field.
-
handleType
public VkImportFenceWin32HandleInfoKHR handleType(int value)
Sets the specified value to thehandleType
field.
-
handle
public VkImportFenceWin32HandleInfoKHR handle(long value)
Sets the specified value to thehandle
field.
-
name
public VkImportFenceWin32HandleInfoKHR name(java.nio.ByteBuffer value)
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, java.nio.ByteBuffer name)
Initializes this struct with the specified values.
-
set
public VkImportFenceWin32HandleInfoKHR set(VkImportFenceWin32HandleInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImportFenceWin32HandleInfoKHR malloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImportFenceWin32HandleInfoKHR calloc()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImportFenceWin32HandleInfoKHR create()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkImportFenceWin32HandleInfoKHR create(long address)
Returns a newVkImportFenceWin32HandleInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkImportFenceWin32HandleInfoKHR createSafe(long address)
-
malloc
public static VkImportFenceWin32HandleInfoKHR.Buffer malloc(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImportFenceWin32HandleInfoKHR.Buffer calloc(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImportFenceWin32HandleInfoKHR.Buffer create(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImportFenceWin32HandleInfoKHR.Buffer create(long address, int capacity)
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
public static VkImportFenceWin32HandleInfoKHR mallocStack()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImportFenceWin32HandleInfoKHR callocStack()
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImportFenceWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImportFenceWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImportFenceWin32HandleInfoKHR.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()
.
-
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
public static java.nio.ByteBuffer nname(long struct)
Unsafe version ofname()
.
-
nnameString
public static java.lang.String nnameString(long struct)
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
public static void nname(long struct, java.nio.ByteBuffer value)
Unsafe version ofname
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-