Package org.lwjgl.vulkan

Class VkSharedPresentSurfaceCapabilitiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSharedPresentSurfaceCapabilitiesKHR>

org.lwjgl.vulkan.VkSharedPresentSurfaceCapabilitiesKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSharedPresentSurfaceCapabilitiesKHR
extends Struct<VkSharedPresentSurfaceCapabilitiesKHR>
implements NativeResource

Structure describing capabilities of a surface for shared presentation.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR

Layout

 struct VkSharedPresentSurfaceCapabilitiesKHR {
     VkStructureType sType();
     void * pNext();
     VkImageUsageFlags sharedPresentSupportedUsageFlags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSharedPresentSurfaceCapabilitiesKHR.Buffer	An array of VkSharedPresentSurfaceCapabilitiesKHR structs.

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SHAREDPRESENTSUPPORTEDUSAGEFLAGS	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
VkSharedPresentSurfaceCapabilitiesKHR(ByteBuffer container)	Creates a VkSharedPresentSurfaceCapabilitiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSharedPresentSurfaceCapabilitiesKHR	calloc()	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with memCalloc.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	calloc(int capacity)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with memCalloc.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSharedPresentSurfaceCapabilitiesKHR	calloc(MemoryStack stack)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSharedPresentSurfaceCapabilitiesKHR	callocStack()	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR	callocStack(MemoryStack stack)	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR	create()	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with BufferUtils.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	create(int capacity)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.
static VkSharedPresentSurfaceCapabilitiesKHR	create(long address)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance for the specified memory address.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	create(long address, int capacity)	Create a VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance at the specified memory.
static VkSharedPresentSurfaceCapabilitiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSharedPresentSurfaceCapabilitiesKHR	malloc()	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with memAlloc.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	malloc(int capacity)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with memAlloc.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkSharedPresentSurfaceCapabilitiesKHR	malloc(MemoryStack stack)	Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack.
static VkSharedPresentSurfaceCapabilitiesKHR	mallocStack()	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSharedPresentSurfaceCapabilitiesKHR	mallocStack(MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsharedPresentSupportedUsageFlags(long struct)	Unsafe version of sharedPresentSupportedUsageFlags().
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.
VkSharedPresentSurfaceCapabilitiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkSharedPresentSurfaceCapabilitiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkSharedPresentSurfaceCapabilitiesKHR	set(VkSharedPresentSurfaceCapabilitiesKHR src)	Copies the specified struct data to this struct.
int	sharedPresentSupportedUsageFlags()	a bitmask of VkImageUsageFlagBits representing the ways the application can use the shared presentable image from a swapchain created with VkPresentModeKHR set to PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR for the surface on the specified device.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkSharedPresentSurfaceCapabilitiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkSharedPresentSurfaceCapabilitiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

SHAREDPRESENTSUPPORTEDUSAGEFLAGS

public static final int SHAREDPRESENTSUPPORTEDUSAGEFLAGS

The struct member offsets.

Constructor Details

VkSharedPresentSurfaceCapabilitiesKHR

public VkSharedPresentSurfaceCapabilitiesKHR(ByteBuffer container)

Creates a VkSharedPresentSurfaceCapabilitiesKHR 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSharedPresentSurfaceCapabilitiesKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

sharedPresentSupportedUsageFlags

public int sharedPresentSupportedUsageFlags()

a bitmask of VkImageUsageFlagBits representing the ways the application can use the shared presentable image from a swapchain created with VkPresentModeKHR set to PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR for the surface on the specified device. IMAGE_USAGE_COLOR_ATTACHMENT_BIT must be included in the set but implementations may support additional usages.

sType

public VkSharedPresentSurfaceCapabilitiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSharedPresentSurfaceCapabilitiesKHR sType$Default()

Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the sType() field.

pNext

public VkSharedPresentSurfaceCapabilitiesKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkSharedPresentSurfaceCapabilitiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSharedPresentSurfaceCapabilitiesKHR set(VkSharedPresentSurfaceCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSharedPresentSurfaceCapabilitiesKHR malloc()

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

calloc

public static VkSharedPresentSurfaceCapabilitiesKHR calloc()

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

create

public static VkSharedPresentSurfaceCapabilitiesKHR create()

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with BufferUtils.

create

public static VkSharedPresentSurfaceCapabilitiesKHR create(long address)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance for the specified memory address.

createSafe

@Nullable
public static VkSharedPresentSurfaceCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer create(int capacity)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkSharedPresentSurfaceCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSharedPresentSurfaceCapabilitiesKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

nsharedPresentSupportedUsageFlags

public static int nsharedPresentSupportedUsageFlags(long struct)

Unsafe version of sharedPresentSupportedUsageFlags().

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.