Class VkExternalBufferProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExternalBufferProperties>

org.lwjgl.vulkan.VkExternalBufferProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkExternalBufferPropertiesKHR

public class VkExternalBufferProperties
extends Struct<VkExternalBufferProperties>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EXTERNALMEMORYPROPERTIES	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkExternalBufferProperties(ByteBuffer container)	Creates a VkExternalBufferProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExternalBufferProperties	calloc()	Returns a new VkExternalBufferProperties instance allocated with memCalloc.
static VkExternalBufferProperties.Buffer	calloc(int capacity)	Returns a new VkExternalBufferProperties.Buffer instance allocated with memCalloc.
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.
static VkExternalBufferProperties	calloc(MemoryStack stack)	Returns a new VkExternalBufferProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExternalBufferProperties	create()	Returns a new VkExternalBufferProperties instance allocated with BufferUtils.
static VkExternalBufferProperties.Buffer	create(int capacity)	Returns a new VkExternalBufferProperties.Buffer instance allocated with BufferUtils.
static VkExternalBufferProperties	create(long address)	Returns a new VkExternalBufferProperties instance for the specified memory address.
static VkExternalBufferProperties.Buffer	create(long address, int capacity)	Create a VkExternalBufferProperties.Buffer instance at the specified memory.
static @Nullable VkExternalBufferProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExternalBufferProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExternalMemoryProperties	externalMemoryProperties()
static VkExternalBufferProperties	malloc()	Returns a new VkExternalBufferProperties instance allocated with memAlloc.
static VkExternalBufferProperties.Buffer	malloc(int capacity)	Returns a new VkExternalBufferProperties.Buffer instance allocated with memAlloc.
static VkExternalBufferProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkExternalBufferProperties.Buffer instance allocated on the specified MemoryStack.
static VkExternalBufferProperties	malloc(MemoryStack stack)	Returns a new VkExternalBufferProperties instance allocated on the specified MemoryStack.
static VkExternalMemoryProperties	nexternalMemoryProperties(long struct)	Unsafe version of externalMemoryProperties().
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()
VkExternalBufferProperties	pNext(long value)	Sets the specified value to the pNext field.
VkExternalBufferProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkExternalBufferProperties	set(VkExternalBufferProperties src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkExternalBufferProperties	sType(int value)	Sets the specified value to the sType field.
VkExternalBufferProperties	sType$Default()	Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

EXTERNALMEMORYPROPERTIES

public static final int EXTERNALMEMORYPROPERTIES

The struct member offsets.

Constructor Details

VkExternalBufferProperties

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkExternalBufferProperties>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

externalMemoryProperties

public VkExternalMemoryProperties externalMemoryProperties()

Returns:

a VkExternalMemoryProperties view of the externalMemoryProperties field.

sType

public VkExternalBufferProperties sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkExternalBufferProperties sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_BUFFER_PROPERTIES value to the sType field.

pNext

public VkExternalBufferProperties pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

set

public VkExternalBufferProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkExternalBufferProperties set(VkExternalBufferProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExternalBufferProperties malloc()

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

calloc

public static VkExternalBufferProperties calloc()

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

create

public static VkExternalBufferProperties create()

Returns a new VkExternalBufferProperties instance allocated with BufferUtils.

create

public static VkExternalBufferProperties create(long address)

Returns a new VkExternalBufferProperties instance for the specified memory address.

createSafe

public static @Nullable VkExternalBufferProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExternalBufferProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExternalBufferProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExternalBufferProperties.Buffer create(int capacity)

Returns a new VkExternalBufferProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExternalBufferProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkExternalBufferProperties malloc(MemoryStack stack)

Returns a new VkExternalBufferProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - 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().

nexternalMemoryProperties

public static VkExternalMemoryProperties nexternalMemoryProperties(long struct)

Unsafe version of externalMemoryProperties().

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.