Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindImagePlaneMemoryInfo

extends Struct<VkBindImagePlaneMemoryInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBindImagePlaneMemoryInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying how to bind an image plane to memory.
Valid Usage
Valid Usage (Implicit)

Layout


struct VkBindImagePlaneMemoryInfo {
    VkStructureType sType;
    void const * pNext;
    VkImageAspectFlagBits planeAspect;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkBindImagePlaneMemoryInfo.Buffer

An array of VkBindImagePlaneMemoryInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PLANEASPECT

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

public
VkBindImagePlaneMemoryInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkBindImagePlaneMemoryInfo
calloc()

Returns a new VkBindImagePlaneMemoryInfo instance allocated with memCalloc.

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

Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBindImagePlaneMemoryInfo
callocStack()

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

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

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

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

Returns a new VkBindImagePlaneMemoryInfo instance allocated with BufferUtils.

public static VkBindImagePlaneMemoryInfo
create(long address)

Returns a new VkBindImagePlaneMemoryInfo instance for the specified memory address.

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

Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with BufferUtils.

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

Create a VkBindImagePlaneMemoryInfo.Buffer instance at the specified memory.

public static VkBindImagePlaneMemoryInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkBindImagePlaneMemoryInfo
malloc()

Returns a new VkBindImagePlaneMemoryInfo instance allocated with memAlloc.

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

Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkBindImagePlaneMemoryInfo instance allocated on the specified MemoryStack.

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

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

public static VkBindImagePlaneMemoryInfo
mallocStack()

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

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

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

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

Unsafe version of planeAspect.

public static void
nplaneAspect(long struct, int value)

Unsafe version of planeAspect.

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 int
planeAspect()

a VkImageAspectFlagBits value specifying the aspect of the disjoint image plane to bind.

public VkBindImagePlaneMemoryInfo
planeAspect(int value)

Sets the specified value to the planeAspect field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBindImagePlaneMemoryInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBindImagePlaneMemoryInfo
set(int sType, long pNext, int planeAspect)

Initializes this struct with the specified values.

public VkBindImagePlaneMemoryInfo

Returns:

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

Sets the specified value to the sType field.

public VkBindImagePlaneMemoryInfo
sType$Default()

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

PLANEASPECTback to summary
public static final int PLANEASPECT

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

VkBindImagePlaneMemoryInfoback to summary
protected VkBindImagePlaneMemoryInfo(long address, ByteBuffer container)
VkBindImagePlaneMemoryInfoback to summary
public VkBindImagePlaneMemoryInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBindImagePlaneMemoryInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkBindImagePlaneMemoryInfo instance allocated with BufferUtils.

createback to summary
public static VkBindImagePlaneMemoryInfo create(long address)

Returns a new VkBindImagePlaneMemoryInfo instance for the specified memory address.

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

Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBindImagePlaneMemoryInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBindImagePlaneMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkBindImagePlaneMemoryInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBindImagePlaneMemoryInfo malloc(MemoryStack stack)

Returns a new VkBindImagePlaneMemoryInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nplaneAspectback to summary
public static int nplaneAspect(long struct)

Unsafe version of planeAspect.

nplaneAspectback to summary
public static void nplaneAspect(long struct, int value)

Unsafe version of planeAspect.

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.

planeAspectback to summary
public int planeAspect()

a VkImageAspectFlagBits value specifying the aspect of the disjoint image plane to bind.

Annotations
@NativeType:VkImageAspectFlagBits
planeAspectback to summary
public VkBindImagePlaneMemoryInfo planeAspect(int value)

Sets the specified value to the planeAspect field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkBindImagePlaneMemoryInfo set(VkBindImagePlaneMemoryInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkBindImagePlaneMemoryInfo

the source struct

Returns:VkBindImagePlaneMemoryInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkBindImagePlaneMemoryInfo.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkBindImagePlaneMemoryInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBindImagePlaneMemoryInfo.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
protected VkBindImagePlaneMemoryInfo
getElementFactory()

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

public int

Returns:

the value of the VkBindImagePlaneMemoryInfo#planeAspect field.
planeAspect()

public VkBindImagePlaneMemoryInfo.Buffer
planeAspect(int value)

Sets the specified value to the VkBindImagePlaneMemoryInfo#planeAspect field.

public long

Returns:

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

public VkBindImagePlaneMemoryInfo.Buffer
pNext(long value)

Sets the specified value to the VkBindImagePlaneMemoryInfo#pNext field.

protected VkBindImagePlaneMemoryInfo.Buffer
self()

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

public int

Returns:

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

public VkBindImagePlaneMemoryInfo.Buffer
sType(int value)

Sets the specified value to the VkBindImagePlaneMemoryInfo#sType field.

public VkBindImagePlaneMemoryInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO value to the VkBindImagePlaneMemoryInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBindImagePlaneMemoryInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkBindImagePlaneMemoryInfo getElementFactory()

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

Annotations
@Override
planeAspectback to summary
public int planeAspect()
Returns:int

the value of the VkBindImagePlaneMemoryInfo#planeAspect field.

Annotations
@NativeType:VkImageAspectFlagBits
planeAspectback to summary
public VkBindImagePlaneMemoryInfo.Buffer planeAspect(int value)

Sets the specified value to the VkBindImagePlaneMemoryInfo#planeAspect field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkBindImagePlaneMemoryInfo#pNext field.

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

Sets the specified value to the VkBindImagePlaneMemoryInfo#pNext field.

selfback to summary
protected VkBindImagePlaneMemoryInfo.Buffer self()

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

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

the value of the VkBindImagePlaneMemoryInfo#sType field.

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

Sets the specified value to the VkBindImagePlaneMemoryInfo#sType field.

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

Sets the STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO value to the VkBindImagePlaneMemoryInfo#sType field.