Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDedicatedAllocationImageCreateInfoNV

extends Struct<VkDedicatedAllocationImageCreateInfoNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDedicatedAllocationImageCreateInfoNV.Buffer

An array of VkDedicatedAllocationImageCreateInfoNV structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEDICATEDALLOCATION

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

public
VkDedicatedAllocationImageCreateInfoNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDedicatedAllocationImageCreateInfoNV
calloc()

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with memCalloc.

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

Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDedicatedAllocationImageCreateInfoNV
callocStack()

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

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

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

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

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with BufferUtils.

public static VkDedicatedAllocationImageCreateInfoNV
create(long address)

Returns a new VkDedicatedAllocationImageCreateInfoNV instance for the specified memory address.

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

Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with BufferUtils.

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

Create a VkDedicatedAllocationImageCreateInfoNV.Buffer instance at the specified memory.

public static VkDedicatedAllocationImageCreateInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
dedicatedAllocation()

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

public VkDedicatedAllocationImageCreateInfoNV
dedicatedAllocation(boolean value)

Sets the specified value to the dedicatedAllocation field.

public static VkDedicatedAllocationImageCreateInfoNV
malloc()

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with memAlloc.

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

Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with memAlloc.

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

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated on the specified MemoryStack.

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

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

public static VkDedicatedAllocationImageCreateInfoNV
mallocStack()

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

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

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

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

Unsafe version of dedicatedAllocation.

public static void
ndedicatedAllocation(long struct, int value)

Unsafe version of dedicatedAllocation.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkDedicatedAllocationImageCreateInfoNV

Returns:

this struct
set(VkDedicatedAllocationImageCreateInfoNV
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 VkDedicatedAllocationImageCreateInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkDedicatedAllocationImageCreateInfoNV
sType$Default()

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

DEDICATEDALLOCATIONback to summary
public static final int DEDICATEDALLOCATION

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

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

callocback to summary
public static VkDedicatedAllocationImageCreateInfoNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDedicatedAllocationImageCreateInfoNV calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated with BufferUtils.

createback to summary
public static VkDedicatedAllocationImageCreateInfoNV create(long address)

Returns a new VkDedicatedAllocationImageCreateInfoNV instance for the specified memory address.

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

Returns a new VkDedicatedAllocationImageCreateInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDedicatedAllocationImageCreateInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDedicatedAllocationImageCreateInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
dedicatedAllocationback to summary
public boolean dedicatedAllocation()

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

Annotations
@NativeType:VkBool32
dedicatedAllocationback to summary
public VkDedicatedAllocationImageCreateInfoNV dedicatedAllocation(boolean value)

Sets the specified value to the dedicatedAllocation field.

mallocback to summary
public static VkDedicatedAllocationImageCreateInfoNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDedicatedAllocationImageCreateInfoNV malloc(MemoryStack stack)

Returns a new VkDedicatedAllocationImageCreateInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndedicatedAllocationback to summary
public static int ndedicatedAllocation(long struct)

Unsafe version of dedicatedAllocation.

ndedicatedAllocationback to summary
public static void ndedicatedAllocation(long struct, int value)

Unsafe version of dedicatedAllocation.

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 const *
pNextback to summary
public VkDedicatedAllocationImageCreateInfoNV pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkDedicatedAllocationImageCreateInfoNV set(VkDedicatedAllocationImageCreateInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkDedicatedAllocationImageCreateInfoNV

the source struct

Returns:VkDedicatedAllocationImageCreateInfoNV

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDedicatedAllocationImageCreateInfoNV.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkDedicatedAllocationImageCreateInfoNV
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDedicatedAllocationImageCreateInfoNV.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 boolean

Returns:

the value of the VkDedicatedAllocationImageCreateInfoNV#dedicatedAllocation field.
dedicatedAllocation()

public VkDedicatedAllocationImageCreateInfoNV.Buffer
dedicatedAllocation(boolean value)

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#dedicatedAllocation field.

protected VkDedicatedAllocationImageCreateInfoNV
getElementFactory()

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

public long

Returns:

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

public VkDedicatedAllocationImageCreateInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#pNext field.

protected VkDedicatedAllocationImageCreateInfoNV.Buffer
self()

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

public int

Returns:

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

public VkDedicatedAllocationImageCreateInfoNV.Buffer
sType(int value)

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#sType field.

public VkDedicatedAllocationImageCreateInfoNV.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV value to the VkDedicatedAllocationImageCreateInfoNV#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDedicatedAllocationImageCreateInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

dedicatedAllocationback to summary
public boolean dedicatedAllocation()
Returns:boolean

the value of the VkDedicatedAllocationImageCreateInfoNV#dedicatedAllocation field.

Annotations
@NativeType:VkBool32
dedicatedAllocationback to summary
public VkDedicatedAllocationImageCreateInfoNV.Buffer dedicatedAllocation(boolean value)

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#dedicatedAllocation field.

getElementFactoryback to summary
protected VkDedicatedAllocationImageCreateInfoNV getElementFactory()

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

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

the value of the VkDedicatedAllocationImageCreateInfoNV#pNext field.

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

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#pNext field.

selfback to summary
protected VkDedicatedAllocationImageCreateInfoNV.Buffer self()

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

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

the value of the VkDedicatedAllocationImageCreateInfoNV#sType field.

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

Sets the specified value to the VkDedicatedAllocationImageCreateInfoNV#sType field.

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

Sets the STRUCTURE_TYPE_DEDICATED_ALLOCATION_IMAGE_CREATE_INFO_NV value to the VkDedicatedAllocationImageCreateInfoNV#sType field.