Package org.lwjgl.vulkan

Class VkDedicatedAllocationImageCreateInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDedicatedAllocationImageCreateInfoNV>

org.lwjgl.vulkan.VkDedicatedAllocationImageCreateInfoNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDedicatedAllocationImageCreateInfoNV
extends org.lwjgl.system.Struct<VkDedicatedAllocationImageCreateInfoNV>
implements org.lwjgl.system.NativeResource

Specify that an image is bound to a dedicated memory resource.

Description

Note

Using a dedicated allocation for color and depth/stencil attachments or other large images may improve performance on some devices.

Valid Usage

• If dedicatedAllocation is TRUE, VkImageCreateInfo::flags must not include IMAGE_CREATE_SPARSE_BINDING_BIT, IMAGE_CREATE_SPARSE_RESIDENCY_BIT, or IMAGE_CREATE_SPARSE_ALIASED_BIT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV

Layout

 struct VkDedicatedAllocationImageCreateInfoNV {
     VkStructureType sType();
     void const * pNext();
     VkBool32 dedicatedAllocation();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDedicatedAllocationImageCreateInfoNV	calloc()	Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with memCalloc.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	calloc(int capacity)	Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with memCalloc.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDedicatedAllocationImageCreateInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDedicatedAllocationImageCreateInfoNV	callocStack()	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	callocStack(int capacity)	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV	create()	Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with BufferUtils.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	create(int capacity)	Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with BufferUtils.
static VkDedicatedAllocationImageCreateInfoNV	create(long address)	Returns a new VkDedicatedAllocationImageCreateInfoNV instance for the specified memory address.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	create(long address, int capacity)	Create a VkDedicatedAllocationImageCreateInfoNV.Buffer instance at the specified memory.
static @Nullable VkDedicatedAllocationImageCreateInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDedicatedAllocationImageCreateInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	dedicatedAllocation()	specifies whether the image will have a dedicated allocation bound to it.
VkDedicatedAllocationImageCreateInfoNV	dedicatedAllocation(boolean value)	Sets the specified value to the dedicatedAllocation() field.
static VkDedicatedAllocationImageCreateInfoNV	malloc()	Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with memAlloc.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	malloc(int capacity)	Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with memAlloc.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkDedicatedAllocationImageCreateInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated on the specified MemoryStack.
static VkDedicatedAllocationImageCreateInfoNV	mallocStack()	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	mallocStack(int capacity)	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDedicatedAllocationImageCreateInfoNV	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ndedicatedAllocation(long struct)	Unsafe version of dedicatedAllocation().
static void	ndedicatedAllocation(long struct, int value)	Unsafe version of dedicatedAllocation.
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()	NULL or a pointer to a structure extending this structure.
VkDedicatedAllocationImageCreateInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkDedicatedAllocationImageCreateInfoNV	set(int sType, long pNext, boolean dedicatedAllocation)	Initializes this struct with the specified values.
VkDedicatedAllocationImageCreateInfoNV	set(VkDedicatedAllocationImageCreateInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDedicatedAllocationImageCreateInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkDedicatedAllocationImageCreateInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

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

DEDICATEDALLOCATION

public static final int DEDICATEDALLOCATION

The struct member offsets.

Constructor Details

VkDedicatedAllocationImageCreateInfoNV

public VkDedicatedAllocationImageCreateInfoNV(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDedicatedAllocationImageCreateInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

dedicatedAllocation

public boolean dedicatedAllocation()

specifies whether the image will have a dedicated allocation bound to it.

sType

public VkDedicatedAllocationImageCreateInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDedicatedAllocationImageCreateInfoNV sType$Default()

Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV value to the sType() field.

pNext

public VkDedicatedAllocationImageCreateInfoNV pNext(long value)

Sets the specified value to the pNext() field.

dedicatedAllocation

public VkDedicatedAllocationImageCreateInfoNV dedicatedAllocation(boolean value)

Sets the specified value to the dedicatedAllocation() field.

set

public VkDedicatedAllocationImageCreateInfoNV set(int sType,
 long pNext,
 boolean dedicatedAllocation)

Initializes this struct with the specified values.

set

public VkDedicatedAllocationImageCreateInfoNV set(VkDedicatedAllocationImageCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDedicatedAllocationImageCreateInfoNV malloc()

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

calloc

public static VkDedicatedAllocationImageCreateInfoNV calloc()

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

create

public static VkDedicatedAllocationImageCreateInfoNV create()

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with BufferUtils.

create

public static VkDedicatedAllocationImageCreateInfoNV create(long address)

Returns a new VkDedicatedAllocationImageCreateInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkDedicatedAllocationImageCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDedicatedAllocationImageCreateInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDedicatedAllocationImageCreateInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDedicatedAllocationImageCreateInfoNV.Buffer create(int capacity)

Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDedicatedAllocationImageCreateInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDedicatedAllocationImageCreateInfoNV.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkDedicatedAllocationImageCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDedicatedAllocationImageCreateInfoNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDedicatedAllocationImageCreateInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDedicatedAllocationImageCreateInfoNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

ndedicatedAllocation

public static int ndedicatedAllocation(long struct)

Unsafe version of dedicatedAllocation().

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.

ndedicatedAllocation

public static void ndedicatedAllocation(long struct,
 int value)

Unsafe version of dedicatedAllocation.