java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImportFenceWin32HandleInfoKHR>

org.lwjgl.vulkan.VkImportFenceWin32HandleInfoKHR

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImportFenceWin32HandleInfoKHR extends org.lwjgl.system.Struct<VkImportFenceWin32HandleInfoKHR> 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 not EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_WIN32_BIT, name must be NULL
If handle is NULL, name must name a valid synchronization primitive of the type specified by handleType
If name is NULL, handle must be a valid handle of the type specified by handleType
If handle is not NULL, name must be NULL
If handle is not NULL, it must obey any requirements listed for handleType in external fence handle types compatibility
If name is not NULL, it must obey any requirements listed for handleType in external fence handle types compatibility

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR
pNext must be NULL
fence must be a valid VkFence handle
flags must be a valid combination of VkFenceImportFlagBits values

Host Synchronization

Host access to fence must be externally synchronized

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 of VkImportFenceWin32HandleInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

FENCE

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

HANDLE

The struct member offsets.

static final int

HANDLETYPE

The struct member offsets.

static final int

NAME

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STYPE

The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkImportFenceWin32HandleInfoKHR(ByteBuffer container)

Creates a VkImportFenceWin32HandleInfoKHR instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VkImportFenceWin32HandleInfoKHR

calloc()

Returns a new VkImportFenceWin32HandleInfoKHR instance allocated with memCalloc.

static VkImportFenceWin32HandleInfoKHR.Buffer

calloc(int capacity)

Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with memCalloc.

static VkImportFenceWin32HandleInfoKHR.Buffer

calloc(int capacity, org.lwjgl.system.MemoryStack stack)

Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VkImportFenceWin32HandleInfoKHR

calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImportFenceWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VkImportFenceWin32HandleInfoKHR

callocStack()

Deprecated.

static VkImportFenceWin32HandleInfoKHR.Buffer

callocStack(int capacity)

Deprecated.

static VkImportFenceWin32HandleInfoKHR.Buffer

callocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkImportFenceWin32HandleInfoKHR

callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkImportFenceWin32HandleInfoKHR

create()

Returns a new VkImportFenceWin32HandleInfoKHR instance allocated with BufferUtils.

static VkImportFenceWin32HandleInfoKHR.Buffer

create(int capacity)

Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.

static VkImportFenceWin32HandleInfoKHR

create(long address)

Returns a new VkImportFenceWin32HandleInfoKHR instance for the specified memory address.

static VkImportFenceWin32HandleInfoKHR.Buffer

create(long address, int capacity)

Create a VkImportFenceWin32HandleInfoKHR.Buffer instance at the specified memory.

static @Nullable VkImportFenceWin32HandleInfoKHR

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkImportFenceWin32HandleInfoKHR.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

long

fence()

the fence into which the state will be imported.

VkImportFenceWin32HandleInfoKHR

fence(long value)

Sets the specified value to the fence() field.

int

flags()

a bitmask of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.

VkImportFenceWin32HandleInfoKHR

flags(int value)

Sets the specified value to the flags() field.

long

handle()

NULL or the external handle to import.

VkImportFenceWin32HandleInfoKHR

handle(long value)

Sets the specified value to the handle() field.

int

handleType()

a VkExternalFenceHandleTypeFlagBits value specifying the type of handle.

VkImportFenceWin32HandleInfoKHR

handleType(int value)

Sets the specified value to the handleType() field.

static VkImportFenceWin32HandleInfoKHR

malloc()

Returns a new VkImportFenceWin32HandleInfoKHR instance allocated with memAlloc.

static VkImportFenceWin32HandleInfoKHR.Buffer

malloc(int capacity)

Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with memAlloc.

static VkImportFenceWin32HandleInfoKHR.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.

static VkImportFenceWin32HandleInfoKHR

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImportFenceWin32HandleInfoKHR instance allocated on the specified MemoryStack.

static VkImportFenceWin32HandleInfoKHR

mallocStack()

Deprecated.

static VkImportFenceWin32HandleInfoKHR.Buffer

mallocStack(int capacity)

Deprecated.

static VkImportFenceWin32HandleInfoKHR.Buffer

mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkImportFenceWin32HandleInfoKHR

mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

ByteBuffer

name()

NULL or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.

VkImportFenceWin32HandleInfoKHR

name(ByteBuffer value)

Sets the address of the specified encoded string to the name() field.

String

nameString()

NULL or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.

static long

nfence(long struct)

Unsafe version of fence().

static void

nfence(long struct, long value)

Unsafe version of fence.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static long

nhandle(long struct)

Unsafe version of handle().

static void

nhandle(long struct, long value)

Unsafe version of handle.

static int

nhandleType(long struct)

Unsafe version of handleType().

static void

nhandleType(long struct, int value)

Unsafe version of handleType.

static ByteBuffer

nname(long struct)

Unsafe version of name().

static void

nname(long struct, ByteBuffer value)

Unsafe version of name.

static String

nnameString(long struct)

Unsafe version of nameString().

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

long

pNext()

NULL or a pointer to a structure extending this structure.

VkImportFenceWin32HandleInfoKHR

pNext(long value)

Sets the specified value to the pNext() field.

VkImportFenceWin32HandleInfoKHR

set(int sType, long pNext, long fence, int flags, int handleType, long handle, 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()

a VkStructureType value identifying this structure.

VkImportFenceWin32HandleInfoKHR

sType(int value)

Sets the specified value to the sType() field.

VkImportFenceWin32HandleInfoKHR

sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR value to the sType() field.

static void

validate(long struct)

Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- STYPE
  
  public static final int STYPE
  
  The struct member offsets.
- PNEXT
  
  public static final int PNEXT
  
  The struct member offsets.
- FENCE
  
  public static final int FENCE
  
  The struct member offsets.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- HANDLETYPE
  
  public static final int HANDLETYPE
  
  The struct member offsets.
- HANDLE
  
  public static final int HANDLE
  
  The struct member offsets.
- NAME
  
  public static final int NAME
  
  The struct member offsets.
Constructor Details
- VkImportFenceWin32HandleInfoKHR
  
  public VkImportFenceWin32HandleInfoKHR(ByteBuffer container)
  
  Creates a VkImportFenceWin32HandleInfoKHR instance at the current position of the specified ByteBuffer 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()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<VkImportFenceWin32HandleInfoKHR>
- sType
  
  public int sType()
  
  a VkStructureType 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 of VkFenceImportFlagBits specifying additional parameters for the fence payload import operation.
- handleType
  
  public int handleType()
  
  a VkExternalFenceHandleTypeFlagBits value specifying the type of handle.
- handle
  
  public long handle()
  
  NULL or the external handle to import.
- name
  
  public ByteBuffer name()
  
  NULL or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.
- nameString
  
  public String nameString()
  
  NULL or a null-terminated UTF-16 string naming the underlying synchronization primitive to import.
- sType
  
  public VkImportFenceWin32HandleInfoKHR sType(int value)
  
  Sets the specified value to the sType() field.
- sType$Default
  
  public VkImportFenceWin32HandleInfoKHR sType$Default()
  
  Sets the STRUCTURE_TYPE_IMPORT_FENCE_WIN32_HANDLE_INFO_KHR value to the sType() field.
- pNext
  
  public VkImportFenceWin32HandleInfoKHR pNext(long value)
  
  Sets the specified value to the pNext() field.
- fence
  
  public VkImportFenceWin32HandleInfoKHR fence(long value)
  
  Sets the specified value to the fence() field.
- flags
  
  public VkImportFenceWin32HandleInfoKHR flags(int value)
  
  Sets the specified value to the flags() field.
- handleType
  
  public VkImportFenceWin32HandleInfoKHR handleType(int value)
  
  Sets the specified value to the handleType() field.
- handle
  
  public VkImportFenceWin32HandleInfoKHR handle(long value)
  
  Sets the specified value to the handle() field.
- name
  
  public VkImportFenceWin32HandleInfoKHR name(ByteBuffer value)
  
  Sets the address of the specified encoded string to the name() 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
  
  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 new VkImportFenceWin32HandleInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkImportFenceWin32HandleInfoKHR calloc()
  
  Returns a new VkImportFenceWin32HandleInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkImportFenceWin32HandleInfoKHR create()
  
  Returns a new VkImportFenceWin32HandleInfoKHR instance allocated with BufferUtils.
- create
  
  public static VkImportFenceWin32HandleInfoKHR create(long address)
  
  Returns a new VkImportFenceWin32HandleInfoKHR instance for the specified memory address.
- createSafe
  
  public static @Nullable VkImportFenceWin32HandleInfoKHR createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer malloc(int capacity)
  
  Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer calloc(int capacity)
  
  Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer create(int capacity)
  
  Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer create(long address, int capacity)
  
  Create a VkImportFenceWin32HandleInfoKHR.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkImportFenceWin32HandleInfoKHR.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkImportFenceWin32HandleInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkImportFenceWin32HandleInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImportFenceWin32HandleInfoKHR instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImportFenceWin32HandleInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImportFenceWin32HandleInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImportFenceWin32HandleInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkImportFenceWin32HandleInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nsType
  
  public static int nsType(long struct)
  
  Unsafe version of sType().
- npNext
  
  public static long npNext(long struct)
  
  Unsafe version of pNext().
- nfence
  
  public static long nfence(long struct)
  
  Unsafe version of fence().
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nhandleType
  
  public static int nhandleType(long struct)
  
  Unsafe version of handleType().
- nhandle
  
  public static long nhandle(long struct)
  
  Unsafe version of handle().
- nname
  
  public static ByteBuffer nname(long struct)
  
  Unsafe version of name().
- nnameString
  
  public static String nnameString(long struct)
  
  Unsafe version of nameString().
- nsType
  
  public static void nsType(long struct, int value)
  
  Unsafe version of sType.
- npNext
  
  public static void npNext(long struct, long value)
  
  Unsafe version of pNext.
- nfence
  
  public static void nfence(long struct, long value)
  
  Unsafe version of fence.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nhandleType
  
  public static void nhandleType(long struct, int value)
  
  Unsafe version of handleType.
- nhandle
  
  public static void nhandle(long struct, long value)
  
  Unsafe version of handle.
- nname
  
  public static void nname(long struct, ByteBuffer value)
  
  Unsafe version of name.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class VkImportFenceWin32HandleInfoKHR

Description

Handle Types Supported by VkImportFenceWin32HandleInfoKHR

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FENCE

FLAGS

HANDLETYPE

HANDLE

NAME

Constructor Details

VkImportFenceWin32HandleInfoKHR

Method Details

sizeof

sType

pNext

fence

flags

handleType

handle

name

nameString

sType

sType$Default

pNext

fence

flags

handleType

handle

name

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nfence

nflags

nhandleType

nhandle

nname

Handle Types Supported by `VkImportFenceWin32HandleInfoKHR`