Package org.lwjgl.vulkan

Class VkExportSemaphoreCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportSemaphoreCreateInfo>

org.lwjgl.vulkan.VkExportSemaphoreCreateInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkExportSemaphoreCreateInfoKHR

public class VkExportSemaphoreCreateInfo
extends org.lwjgl.system.Struct<VkExportSemaphoreCreateInfo>
implements org.lwjgl.system.NativeResource

Structure specifying handle types that can be exported from a semaphore.

Valid Usage

• The bits in handleTypes must be supported and compatible, as reported by VkExternalSemaphoreProperties

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO
• handleTypes must be a valid combination of VkExternalSemaphoreHandleTypeFlagBits values

Layout

 struct VkExportSemaphoreCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkExternalSemaphoreHandleTypeFlags handleTypes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExportSemaphoreCreateInfo.Buffer	An array of VkExportSemaphoreCreateInfo 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	HANDLETYPES	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
VkExportSemaphoreCreateInfo(ByteBuffer container)	Creates a VkExportSemaphoreCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExportSemaphoreCreateInfo	calloc()	Returns a new VkExportSemaphoreCreateInfo instance allocated with memCalloc.
static VkExportSemaphoreCreateInfo.Buffer	calloc(int capacity)	Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with memCalloc.
static VkExportSemaphoreCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportSemaphoreCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportSemaphoreCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportSemaphoreCreateInfo	callocStack()	Deprecated.
static VkExportSemaphoreCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkExportSemaphoreCreateInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportSemaphoreCreateInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportSemaphoreCreateInfo	create()	Returns a new VkExportSemaphoreCreateInfo instance allocated with BufferUtils.
static VkExportSemaphoreCreateInfo.Buffer	create(int capacity)	Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with BufferUtils.
static VkExportSemaphoreCreateInfo	create(long address)	Returns a new VkExportSemaphoreCreateInfo instance for the specified memory address.
static VkExportSemaphoreCreateInfo.Buffer	create(long address, int capacity)	Create a VkExportSemaphoreCreateInfo.Buffer instance at the specified memory.
static @Nullable VkExportSemaphoreCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExportSemaphoreCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	handleTypes()	a bitmask of VkExternalSemaphoreHandleTypeFlagBits specifying one or more semaphore handle types the application can export from the resulting semaphore.
VkExportSemaphoreCreateInfo	handleTypes(int value)	Sets the specified value to the handleTypes() field.
static VkExportSemaphoreCreateInfo	malloc()	Returns a new VkExportSemaphoreCreateInfo instance allocated with memAlloc.
static VkExportSemaphoreCreateInfo.Buffer	malloc(int capacity)	Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with memAlloc.
static VkExportSemaphoreCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkExportSemaphoreCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportSemaphoreCreateInfo instance allocated on the specified MemoryStack.
static VkExportSemaphoreCreateInfo	mallocStack()	Deprecated.
static VkExportSemaphoreCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkExportSemaphoreCreateInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkExportSemaphoreCreateInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nhandleTypes(long struct)	Unsafe version of handleTypes().
static void	nhandleTypes(long struct, int value)	Unsafe version of handleTypes.
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.
VkExportSemaphoreCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkExportSemaphoreCreateInfo	set(int sType, long pNext, int handleTypes)	Initializes this struct with the specified values.
VkExportSemaphoreCreateInfo	set(VkExportSemaphoreCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExportSemaphoreCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkExportSemaphoreCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO value to the sType() field.

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.

HANDLETYPES

public static final int HANDLETYPES

The struct member offsets.

Constructor Details

VkExportSemaphoreCreateInfo

public VkExportSemaphoreCreateInfo(ByteBuffer container)

Creates a VkExportSemaphoreCreateInfo 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<VkExportSemaphoreCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

handleTypes

public int handleTypes()

a bitmask of VkExternalSemaphoreHandleTypeFlagBits specifying one or more semaphore handle types the application can export from the resulting semaphore. The application can request multiple handle types for the same semaphore.

sType

public VkExportSemaphoreCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportSemaphoreCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_SEMAPHORE_CREATE_INFO value to the sType() field.

pNext

public VkExportSemaphoreCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

handleTypes

public VkExportSemaphoreCreateInfo handleTypes(int value)

Sets the specified value to the handleTypes() field.

set

public VkExportSemaphoreCreateInfo set(int sType,
 long pNext,
 int handleTypes)

Initializes this struct with the specified values.

set

public VkExportSemaphoreCreateInfo set(VkExportSemaphoreCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportSemaphoreCreateInfo malloc()

Returns a new VkExportSemaphoreCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkExportSemaphoreCreateInfo calloc()

Returns a new VkExportSemaphoreCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkExportSemaphoreCreateInfo create()

Returns a new VkExportSemaphoreCreateInfo instance allocated with BufferUtils.

create

public static VkExportSemaphoreCreateInfo create(long address)

Returns a new VkExportSemaphoreCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkExportSemaphoreCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportSemaphoreCreateInfo.Buffer malloc(int capacity)

Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkExportSemaphoreCreateInfo.Buffer calloc(int capacity)

Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkExportSemaphoreCreateInfo.Buffer create(int capacity)

Returns a new VkExportSemaphoreCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkExportSemaphoreCreateInfo.Buffer create(long address,
 int capacity)

Create a VkExportSemaphoreCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkExportSemaphoreCreateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkExportSemaphoreCreateInfo mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExportSemaphoreCreateInfo callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExportSemaphoreCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkExportSemaphoreCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkExportSemaphoreCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkExportSemaphoreCreateInfo.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkExportSemaphoreCreateInfo.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 VkExportSemaphoreCreateInfo.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 VkExportSemaphoreCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkExportSemaphoreCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkExportSemaphoreCreateInfo calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkExportSemaphoreCreateInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkExportSemaphoreCreateInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkExportSemaphoreCreateInfo.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().

nhandleTypes

public static int nhandleTypes(long struct)

Unsafe version of handleTypes().

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.

nhandleTypes

public static void nhandleTypes(long struct,
 int value)

Unsafe version of handleTypes.