Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalBufferProperties

extends Struct<VkExternalBufferProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalBufferPropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying supported external handle capabilities.
Valid Usage (Implicit)
See Also

VkExternalMemoryProperties, GetPhysicalDeviceExternalBufferProperties, GetPhysicalDeviceExternalBufferPropertiesKHR

Layout


struct VkExternalBufferProperties {
    VkStructureType sType;
    void * pNext;
    VkExternalMemoryProperties externalMemoryProperties;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkExternalBufferProperties.Buffer

An array of VkExternalBufferProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXTERNALMEMORYPROPERTIES

The struct member offsets.

public static final int
PNEXT

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
VkExternalBufferProperties(long address, ByteBuffer container)

public
VkExternalBufferProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExternalBufferProperties
calloc()

Returns a new VkExternalBufferProperties instance allocated with memCalloc.

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

Returns a new VkExternalBufferProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkExternalBufferProperties
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkExternalBufferProperties
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 VkExternalBufferProperties
create()

Returns a new VkExternalBufferProperties instance allocated with BufferUtils.

public static VkExternalBufferProperties
create(long address)

Returns a new VkExternalBufferProperties instance for the specified memory address.

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

Returns a new VkExternalBufferProperties.Buffer instance allocated with BufferUtils.

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

Create a VkExternalBufferProperties.Buffer instance at the specified memory.

public static VkExternalBufferProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public VkExternalMemoryProperties
externalMemoryProperties()

a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified buffer creation parameters.

public static VkExternalBufferProperties
malloc()

Returns a new VkExternalBufferProperties instance allocated with memAlloc.

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

Returns a new VkExternalBufferProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkExternalBufferProperties instance allocated on the specified MemoryStack.

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

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

public static VkExternalBufferProperties
mallocStack()

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

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

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

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

Unsafe version of externalMemoryProperties.

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
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 VkExternalBufferProperties
pNext(long value)

Sets the specified value to the pNext field.

public VkExternalBufferProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkExternalBufferProperties

Returns:

this struct
set(VkExternalBufferProperties
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkExternalBufferProperties
sType(int value)

Sets the specified value to the sType field.

public VkExternalBufferProperties
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES 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.

EXTERNALMEMORYPROPERTIESback to summary
public static final int EXTERNALMEMORYPROPERTIES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

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

VkExternalBufferPropertiesback to summary
protected VkExternalBufferProperties(long address, ByteBuffer container)
VkExternalBufferPropertiesback to summary
public VkExternalBufferProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalBufferProperties calloc(MemoryStack stack)

Returns a new VkExternalBufferProperties 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 VkExternalBufferProperties.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkExternalBufferProperties.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 VkExternalBufferProperties 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 VkExternalBufferProperties create()

Returns a new VkExternalBufferProperties instance allocated with BufferUtils.

createback to summary
public static VkExternalBufferProperties create(long address)

Returns a new VkExternalBufferProperties instance for the specified memory address.

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

Returns a new VkExternalBufferProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExternalBufferProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalBufferProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
externalMemoryPropertiesback to summary
public VkExternalMemoryProperties externalMemoryProperties()

a VkExternalMemoryProperties structure specifying various capabilities of the external handle type when used with the specified buffer creation parameters.

mallocback to summary
public static VkExternalBufferProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalBufferProperties malloc(MemoryStack stack)

Returns a new VkExternalBufferProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nexternalMemoryPropertiesback to summary
public static VkExternalMemoryProperties nexternalMemoryProperties(long struct)

Unsafe version of externalMemoryProperties.

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.

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 VkExternalBufferProperties pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkExternalBufferProperties set(VkExternalBufferProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalBufferProperties

the source struct

Returns:VkExternalBufferProperties

this struct

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 VkExternalBufferProperties sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalBufferProperties.Buffer

extends StructBuffer<VkExternalBufferProperties, VkExternalBufferProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkExternalBufferPropertiesKHR.Buffer
An array of VkExternalBufferProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkExternalBufferProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExternalBufferProperties.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
public VkExternalMemoryProperties

Returns:

a VkExternalMemoryProperties view of the VkExternalBufferProperties#externalMemoryProperties field.
externalMemoryProperties()

protected VkExternalBufferProperties
getElementFactory()

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

public long

Returns:

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

public VkExternalBufferProperties.Buffer
pNext(long value)

Sets the specified value to the VkExternalBufferProperties#pNext field.

protected VkExternalBufferProperties.Buffer
self()

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

public int

Returns:

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

public VkExternalBufferProperties.Buffer
sType(int value)

Sets the specified value to the VkExternalBufferProperties#sType field.

public VkExternalBufferProperties.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES value to the VkExternalBufferProperties#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalBufferProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExternalBufferProperties.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 VkExternalBufferProperties#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

externalMemoryPropertiesback to summary
public VkExternalMemoryProperties externalMemoryProperties()
Returns:VkExternalMemoryProperties

a VkExternalMemoryProperties view of the VkExternalBufferProperties#externalMemoryProperties field.

getElementFactoryback to summary
protected VkExternalBufferProperties getElementFactory()

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

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

the value of the VkExternalBufferProperties#pNext field.

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

Sets the specified value to the VkExternalBufferProperties#pNext field.

selfback to summary
protected VkExternalBufferProperties.Buffer self()

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

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

the value of the VkExternalBufferProperties#sType field.

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

Sets the specified value to the VkExternalBufferProperties#sType field.

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

Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES value to the VkExternalBufferProperties#sType field.