Structure describing dedicated allocation requirements of buffer and image resources.

Description

To determine the dedicated allocation requirements of a buffer or image resource, add a VkMemoryDedicatedRequirements structure to the pNext chain of the VkMemoryRequirements2 structure passed as the pMemoryRequirements parameter of GetBufferMemoryRequirements2 or GetImageMemoryRequirements2, respectively.

Constraints on the values returned for buffer resources are:

requiresDedicatedAllocation may be TRUE if the pNext chain of VkBufferCreateInfo for the call to vkCreateBuffer used to create the buffer being queried included a VkExternalMemoryBufferCreateInfo structure, and any of the handle types specified in VkExternalMemoryBufferCreateInfo::handleTypes requires dedicated allocation, as reported by GetPhysicalDeviceExternalBufferProperties in VkExternalBufferProperties::externalMemoryProperties.externalMemoryFeatures. Otherwise, requiresDedicatedAllocation will be FALSE.
When the implementation sets requiresDedicatedAllocation to TRUE, it must also set prefersDedicatedAllocation to TRUE.
If BUFFER_CREATE_SPARSE_BINDING_BIT was set in VkBufferCreateInfo::flags when buffer was created, then both prefersDedicatedAllocation and requiresDedicatedAllocation will be FALSE.

Constraints on the values returned for image resources are:

requiresDedicatedAllocation may be TRUE if the pNext chain of VkImageCreateInfo for the call to CreateImage used to create the image being queried included a VkExternalMemoryImageCreateInfo structure, and any of the handle types specified in VkExternalMemoryImageCreateInfo::handleTypes requires dedicated allocation, as reported by GetPhysicalDeviceImageFormatProperties2 in VkExternalImageFormatProperties::externalMemoryProperties.externalMemoryFeatures.
requiresDedicatedAllocation may be TRUE if the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT.
requiresDedicatedAllocation will otherwise be FALSE
If IMAGE_CREATE_SPARSE_BINDING_BIT was set in VkImageCreateInfo::flags when image was created, then both prefersDedicatedAllocation and requiresDedicatedAllocation will be FALSE.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

Layout


struct VkMemoryDedicatedRequirements {
    VkStructureType sType;
    void * pNext;
    VkBool32 prefersDedicatedAllocation;
    VkBool32 requiresDedicatedAllocation;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkMemoryDedicatedRequirements.Buffer An array of `VkMemoryDedicatedRequirements` structs.

Field Summary

Modifier and Type	Field 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	PREFERSDEDICATEDALLOCATION The struct member offsets.
public static final int	REQUIRESDEDICATEDALLOCATION 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkMemoryDedicatedRequirements(long address, ByteBuffer container)
public	VkMemoryDedicatedRequirements(ByteBuffer container) Creates a `VkMemoryDedicatedRequirements` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkMemoryDedicatedRequirements	calloc() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `memCalloc`.
public static VkMemoryDedicatedRequirements.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `memCalloc`.
public static VkMemoryDedicatedRequirements	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkMemoryDedicatedRequirements` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkMemoryDedicatedRequirements.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkMemoryDedicatedRequirements	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkMemoryDedicatedRequirements	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 VkMemoryDedicatedRequirements	create() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `BufferUtils`.
public static VkMemoryDedicatedRequirements	create(long address) Returns a new `VkMemoryDedicatedRequirements` instance for the specified memory address.
public static VkMemoryDedicatedRequirements.Buffer	create(int the buffer capacity capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `BufferUtils`.
public static VkMemoryDedicatedRequirements.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkMemoryDedicatedRequirements.Buffer` instance at the specified memory.
public static VkMemoryDedicatedRequirements	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkMemoryDedicatedRequirements.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkMemoryDedicatedRequirements	malloc() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `memAlloc`.
public static VkMemoryDedicatedRequirements.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `memAlloc`.
public static VkMemoryDedicatedRequirements	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkMemoryDedicatedRequirements` instance allocated on the specified `MemoryStack`.
public static VkMemoryDedicatedRequirements.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated on the specified `MemoryStack`.
public static VkMemoryDedicatedRequirements	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkMemoryDedicatedRequirements.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	nprefersDedicatedAllocation(long struct) Unsafe version of `prefersDedicatedAllocation`.
public static int	nrequiresDedicatedAllocation(long struct) Unsafe version of `requiresDedicatedAllocation`.
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 VkMemoryDedicatedRequirements	pNext(long value) Sets the specified value to the `pNext` field.
public boolean	prefersDedicatedAllocation() specifies that the implementation would prefer a dedicated allocation for this resource.
public boolean	requiresDedicatedAllocation() specifies that a dedicated allocation is required for this resource.
public VkMemoryDedicatedRequirements	set(int sType, long pNext) Initializes this struct with the specified values.
public VkMemoryDedicatedRequirements	Returns: this struct set(VkMemoryDedicatedRequirements 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 VkMemoryDedicatedRequirements	sType(int value) Sets the specified value to the `sType` field.
public VkMemoryDedicatedRequirements	sType$Default() Sets the `STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

PREFERSDEDICATEDALLOCATION	back to summary
public static final int PREFERSDEDICATEDALLOCATION The struct member offsets.

REQUIRESDEDICATEDALLOCATION	back to summary
public static final int REQUIRESDEDICATEDALLOCATION The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkMemoryDedicatedRequirements	back to summary
protected VkMemoryDedicatedRequirements(long address, ByteBuffer container)

VkMemoryDedicatedRequirements back to summary

VkMemoryDedicatedRequirements	back to summary
public VkMemoryDedicatedRequirements(ByteBuffer container) Creates a `VkMemoryDedicatedRequirements` 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.

public VkMemoryDedicatedRequirements(ByteBuffer container)

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

calloc	back to summary
public static VkMemoryDedicatedRequirements calloc() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkMemoryDedicatedRequirements.Buffer calloc(int capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkMemoryDedicatedRequirements.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkMemoryDedicatedRequirements calloc(MemoryStack stack) Returns a new `VkMemoryDedicatedRequirements` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkMemoryDedicatedRequirements calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkMemoryDedicatedRequirements.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkMemoryDedicatedRequirements.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

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

Returns a new VkMemoryDedicatedRequirements.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

callocStack back to summary

callocStack	back to summary
public static VkMemoryDedicatedRequirements callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkMemoryDedicatedRequirements callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkMemoryDedicatedRequirements 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

protected VkMemoryDedicatedRequirements 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

create	back to summary
public static VkMemoryDedicatedRequirements create() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `BufferUtils`.

create	back to summary
public static VkMemoryDedicatedRequirements create(long address) Returns a new `VkMemoryDedicatedRequirements` instance for the specified memory address.

create back to summary

create	back to summary
public static VkMemoryDedicatedRequirements.Buffer create(int capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkMemoryDedicatedRequirements.Buffer create(int capacity)

Returns a new VkMemoryDedicatedRequirements.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkMemoryDedicatedRequirements.Buffer create(long address, int capacity) Create a `VkMemoryDedicatedRequirements.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkMemoryDedicatedRequirements.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkMemoryDedicatedRequirements createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkMemoryDedicatedRequirements createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkMemoryDedicatedRequirements.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkMemoryDedicatedRequirements malloc() Returns a new `VkMemoryDedicatedRequirements` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkMemoryDedicatedRequirements.Buffer malloc(int capacity) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkMemoryDedicatedRequirements.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkMemoryDedicatedRequirements malloc(MemoryStack stack) Returns a new `VkMemoryDedicatedRequirements` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkMemoryDedicatedRequirements malloc(MemoryStack stack)

Returns a new VkMemoryDedicatedRequirements instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkMemoryDedicatedRequirements.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkMemoryDedicatedRequirements.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkMemoryDedicatedRequirements mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkMemoryDedicatedRequirements mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkMemoryDedicatedRequirements.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nprefersDedicatedAllocation	back to summary
public static int nprefersDedicatedAllocation(long struct) Unsafe version of `prefersDedicatedAllocation`.

nrequiresDedicatedAllocation	back to summary
public static int nrequiresDedicatedAllocation(long struct) Unsafe version of `requiresDedicatedAllocation`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void *

pNext	back to summary
public VkMemoryDedicatedRequirements pNext(long value) Sets the specified value to the `pNext` field.

prefersDedicatedAllocation	back to summary
public boolean prefersDedicatedAllocation() specifies that the implementation would prefer a dedicated allocation for this resource. The application is still free to suballocate the resource but it may get better performance if a dedicated allocation is used. Annotations @NativeType:VkBool32

prefersDedicatedAllocation

back to summary

public boolean prefersDedicatedAllocation()

specifies that the implementation would prefer a dedicated allocation for this resource. The application is still free to suballocate the resource but it may get better performance if a dedicated allocation is used.

Annotations

@NativeType:VkBool32

requiresDedicatedAllocation	back to summary
public boolean requiresDedicatedAllocation() specifies that a dedicated allocation is required for this resource. Annotations @NativeType:VkBool32

requiresDedicatedAllocation

back to summary

public boolean requiresDedicatedAllocation()

specifies that a dedicated allocation is required for this resource.

Annotations

@NativeType:VkBool32

set	back to summary
public VkMemoryDedicatedRequirements set(int sType, long pNext) Initializes this struct with the specified values.

set	back to summary
public VkMemoryDedicatedRequirements set(VkMemoryDedicatedRequirements src) Copies the specified struct data to this struct. Parameters src:VkMemoryDedicatedRequirements the source struct Returns:VkMemoryDedicatedRequirements this struct

set

back to summary

public VkMemoryDedicatedRequirements set(VkMemoryDedicatedRequirements src)

Copies the specified struct data to this struct.

Parameters

src:VkMemoryDedicatedRequirements: the source struct

Returns:VkMemoryDedicatedRequirements

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkMemoryDedicatedRequirements sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkMemoryDedicatedRequirements sType$Default() Sets the `STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkMemoryDedicatedRequirements.Buffer

Class Inheritance

extends StructBuffer<VkMemoryDedicatedRequirements, VkMemoryDedicatedRequirements.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkMemoryDedicatedRequirements.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.vulkan.VkMemoryDedicatedRequirementsKHR.Buffer

An array of VkMemoryDedicatedRequirements structs.

Field Summary

Modifier and Type	Field and Description
private static final VkMemoryDedicatedRequirements	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkMemoryDedicatedRequirements.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 Type	Method and Description
protected VkMemoryDedicatedRequirements	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkMemoryDedicatedRequirements#pNext` field. pNext()
public VkMemoryDedicatedRequirements.Buffer	pNext(long value) Sets the specified value to the `VkMemoryDedicatedRequirements#pNext` field.
public boolean	Returns: the value of the `VkMemoryDedicatedRequirements#prefersDedicatedAllocation` field. prefersDedicatedAllocation()
public boolean	Returns: the value of the `VkMemoryDedicatedRequirements#requiresDedicatedAllocation` field. requiresDedicatedAllocation()
protected VkMemoryDedicatedRequirements.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkMemoryDedicatedRequirements#sType` field. sType()
public VkMemoryDedicatedRequirements.Buffer	sType(int value) Sets the specified value to the `VkMemoryDedicatedRequirements#sType` field.
public VkMemoryDedicatedRequirements.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS` value to the `VkMemoryDedicatedRequirements#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkMemoryDedicatedRequirements ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkMemoryDedicatedRequirements.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 VkMemoryDedicatedRequirements#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected VkMemoryDedicatedRequirements getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkMemoryDedicatedRequirements#pNext` field. Annotations @NativeType:void *

pNext	back to summary
public VkMemoryDedicatedRequirements.Buffer pNext(long value) Sets the specified value to the `VkMemoryDedicatedRequirements#pNext` field.

prefersDedicatedAllocation	back to summary
public boolean prefersDedicatedAllocation() Returns:boolean the value of the `VkMemoryDedicatedRequirements#prefersDedicatedAllocation` field. Annotations @NativeType:VkBool32

requiresDedicatedAllocation	back to summary
public boolean requiresDedicatedAllocation() Returns:boolean the value of the `VkMemoryDedicatedRequirements#requiresDedicatedAllocation` field. Annotations @NativeType:VkBool32

self

back to summary

protected VkMemoryDedicatedRequirements.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkMemoryDedicatedRequirements#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkMemoryDedicatedRequirements.Buffer sType(int value) Sets the specified value to the `VkMemoryDedicatedRequirements#sType` field.

sType$Default	back to summary
public VkMemoryDedicatedRequirements.Buffer sType$Default() Sets the `STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS` value to the `VkMemoryDedicatedRequirements#sType` field.