Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSharedPresentSurfaceCapabilitiesKHR

extends Struct<VkSharedPresentSurfaceCapabilitiesKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure describing capabilities of a surface for shared presentation.
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSharedPresentSurfaceCapabilitiesKHR.Buffer

An array of VkSharedPresentSurfaceCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SHAREDPRESENTSUPPORTEDUSAGEFLAGS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSharedPresentSurfaceCapabilitiesKHR(long address, ByteBuffer container)

public
VkSharedPresentSurfaceCapabilitiesKHR(ByteBuffer container)

Creates a VkSharedPresentSurfaceCapabilitiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSharedPresentSurfaceCapabilitiesKHR
calloc()

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with memCalloc.

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with memCalloc.

public static VkSharedPresentSurfaceCapabilitiesKHR
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkSharedPresentSurfaceCapabilitiesKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSharedPresentSurfaceCapabilitiesKHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSharedPresentSurfaceCapabilitiesKHR
create()

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with BufferUtils.

public static VkSharedPresentSurfaceCapabilitiesKHR
create(long address)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance for the specified memory address.

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance at the specified memory.

public static VkSharedPresentSurfaceCapabilitiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSharedPresentSurfaceCapabilitiesKHR
malloc()

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with memAlloc.

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with memAlloc.

public static VkSharedPresentSurfaceCapabilitiesKHR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack.

public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkSharedPresentSurfaceCapabilitiesKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsharedPresentSupportedUsageFlags(long struct)

Unsafe version of sharedPresentSupportedUsageFlags.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSharedPresentSurfaceCapabilitiesKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkSharedPresentSurfaceCapabilitiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkSharedPresentSurfaceCapabilitiesKHR

Returns:

this struct
set(VkSharedPresentSurfaceCapabilitiesKHR
the source struct
src)

Copies the specified struct data to this struct.

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.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkSharedPresentSurfaceCapabilitiesKHR
sType(int value)

Sets the specified value to the sType field.

public VkSharedPresentSurfaceCapabilitiesKHR
sType$Default()

Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the sType field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SHAREDPRESENTSUPPORTEDUSAGEFLAGSback to summary
public static final int SHAREDPRESENTSUPPORTEDUSAGEFLAGS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkSharedPresentSurfaceCapabilitiesKHRback to summary
protected VkSharedPresentSurfaceCapabilitiesKHR(long address, ByteBuffer container)
VkSharedPresentSurfaceCapabilitiesKHRback to summary
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 Detail

callocback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR calloc()

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

callocback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkSharedPresentSurfaceCapabilitiesKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR create()

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated with BufferUtils.

createback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR create(long address)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance for the specified memory address.

createback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer create(int capacity)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR malloc()

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

mallocback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR malloc(MemoryStack stack)

Returns a new VkSharedPresentSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSharedPresentSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsharedPresentSupportedUsageFlagsback to summary
public static int nsharedPresentSupportedUsageFlags(long struct)

Unsafe version of sharedPresentSupportedUsageFlags.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkSharedPresentSurfaceCapabilitiesKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkSharedPresentSurfaceCapabilitiesKHR set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkSharedPresentSurfaceCapabilitiesKHR set(VkSharedPresentSurfaceCapabilitiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSharedPresentSurfaceCapabilitiesKHR

the source struct

Returns:VkSharedPresentSurfaceCapabilitiesKHR

this struct

sharedPresentSupportedUsageFlagsback to summary
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.

Annotations
@NativeType:VkImageUsageFlags
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSharedPresentSurfaceCapabilitiesKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkSharedPresentSurfaceCapabilitiesKHR sType$Default()

Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSharedPresentSurfaceCapabilitiesKHR.Buffer

extends StructBuffer<VkSharedPresentSurfaceCapabilitiesKHR, VkSharedPresentSurfaceCapabilitiesKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkSharedPresentSurfaceCapabilitiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSharedPresentSurfaceCapabilitiesKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkSharedPresentSurfaceCapabilitiesKHR
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public long

Returns:

the value of the VkSharedPresentSurfaceCapabilitiesKHR#pNext field.
pNext()

public VkSharedPresentSurfaceCapabilitiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkSharedPresentSurfaceCapabilitiesKHR#pNext field.

protected VkSharedPresentSurfaceCapabilitiesKHR.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkSharedPresentSurfaceCapabilitiesKHR#sharedPresentSupportedUsageFlags field.
sharedPresentSupportedUsageFlags()

public int

Returns:

the value of the VkSharedPresentSurfaceCapabilitiesKHR#sType field.
sType()

public VkSharedPresentSurfaceCapabilitiesKHR.Buffer
sType(int value)

Sets the specified value to the VkSharedPresentSurfaceCapabilitiesKHR#sType field.

public VkSharedPresentSurfaceCapabilitiesKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the VkSharedPresentSurfaceCapabilitiesKHR#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSharedPresentSurfaceCapabilitiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSharedPresentSurfaceCapabilitiesKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSharedPresentSurfaceCapabilitiesKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkSharedPresentSurfaceCapabilitiesKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSharedPresentSurfaceCapabilitiesKHR#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkSharedPresentSurfaceCapabilitiesKHR.Buffer pNext(long value)

Sets the specified value to the VkSharedPresentSurfaceCapabilitiesKHR#pNext field.

selfback to summary
protected VkSharedPresentSurfaceCapabilitiesKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sharedPresentSupportedUsageFlagsback to summary
public int sharedPresentSupportedUsageFlags()
Returns:int

the value of the VkSharedPresentSurfaceCapabilitiesKHR#sharedPresentSupportedUsageFlags field.

Annotations
@NativeType:VkImageUsageFlags
sTypeback to summary
public int sType()
Returns:int

the value of the VkSharedPresentSurfaceCapabilitiesKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkSharedPresentSurfaceCapabilitiesKHR.Buffer sType(int value)

Sets the specified value to the VkSharedPresentSurfaceCapabilitiesKHR#sType field.

sType$Defaultback to summary
public VkSharedPresentSurfaceCapabilitiesKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_SHARED_PRESENT_SURFACE_CAPABILITIES_KHR value to the VkSharedPresentSurfaceCapabilitiesKHR#sType field.