Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImageViewUsageCreateInfo

extends Struct<VkImageViewUsageCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkImageViewUsageCreateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Specify the intended usage of an image view.
Description

When this structure is chained to VkImageViewCreateInfo the usage field overrides the implicit usage parameter inherited from image creation time and its value is used instead for the purposes of determining the valid usage conditions of VkImageViewCreateInfo.

Valid Usage (Implicit)

Layout


struct VkImageViewUsageCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkImageUsageFlags usage;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkImageViewUsageCreateInfo.Buffer

An array of VkImageViewUsageCreateInfo structs.

Field Summary

Modifier and TypeField 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
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
USAGE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkImageViewUsageCreateInfo(long address, ByteBuffer container)

public
VkImageViewUsageCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImageViewUsageCreateInfo
calloc()

Returns a new VkImageViewUsageCreateInfo instance allocated with memCalloc.

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

Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkImageViewUsageCreateInfo
callocStack()

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

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

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

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

Returns a new VkImageViewUsageCreateInfo instance allocated with BufferUtils.

public static VkImageViewUsageCreateInfo
create(long address)

Returns a new VkImageViewUsageCreateInfo instance for the specified memory address.

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

Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkImageViewUsageCreateInfo.Buffer instance at the specified memory.

public static VkImageViewUsageCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImageViewUsageCreateInfo
malloc()

Returns a new VkImageViewUsageCreateInfo instance allocated with memAlloc.

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

Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkImageViewUsageCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkImageViewUsageCreateInfo
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkImageViewUsageCreateInfo.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
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nusage(long struct)

Unsafe version of usage.

public static void
nusage(long struct, int value)

Unsafe version of usage.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImageViewUsageCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkImageViewUsageCreateInfo
set(int sType, long pNext, int usage)

Initializes this struct with the specified values.

public VkImageViewUsageCreateInfo

Returns:

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

Sets the specified value to the sType field.

public VkImageViewUsageCreateInfo
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the sType field.

public int
usage()

a bitmask of VkImageUsageFlagBits specifying allowed usages of the image view.

public VkImageViewUsageCreateInfo
usage(int value)

Sets the specified value to the usage 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.

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.

USAGEback to summary
public static final int USAGE

The struct member offsets.

Constructor Detail

VkImageViewUsageCreateInfoback to summary
protected VkImageViewUsageCreateInfo(long address, ByteBuffer container)
VkImageViewUsageCreateInfoback to summary
public VkImageViewUsageCreateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImageViewUsageCreateInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkImageViewUsageCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkImageViewUsageCreateInfo create(long address)

Returns a new VkImageViewUsageCreateInfo instance for the specified memory address.

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

Returns a new VkImageViewUsageCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImageViewUsageCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImageViewUsageCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImageViewUsageCreateInfo malloc(MemoryStack stack)

Returns a new VkImageViewUsageCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
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.

nusageback to summary
public static int nusage(long struct)

Unsafe version of usage.

nusageback to summary
public static void nusage(long struct, int value)

Unsafe version of usage.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkImageViewUsageCreateInfo set(int sType, long pNext, int usage)

Initializes this struct with the specified values.

setback to summary
public VkImageViewUsageCreateInfo set(VkImageViewUsageCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkImageViewUsageCreateInfo

the source struct

Returns:VkImageViewUsageCreateInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the sType field.

usageback to summary
public int usage()

a bitmask of VkImageUsageFlagBits specifying allowed usages of the image view.

Annotations
@NativeType:VkImageUsageFlags
usageback to summary
public VkImageViewUsageCreateInfo usage(int value)

Sets the specified value to the usage field.

org.lwjgl.vulkan back to summary

public Class VkImageViewUsageCreateInfo.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkImageViewUsageCreateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public long

Returns:

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

public VkImageViewUsageCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkImageViewUsageCreateInfo#pNext field.

protected VkImageViewUsageCreateInfo.Buffer
self()

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

public int

Returns:

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

public VkImageViewUsageCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkImageViewUsageCreateInfo#sType field.

public VkImageViewUsageCreateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the VkImageViewUsageCreateInfo#sType field.

public int

Returns:

the value of the VkImageViewUsageCreateInfo#usage field.
usage()

public VkImageViewUsageCreateInfo.Buffer
usage(int value)

Sets the specified value to the VkImageViewUsageCreateInfo#usage field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImageViewUsageCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImageViewUsageCreateInfo.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 VkImageViewUsageCreateInfo#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 VkImageViewUsageCreateInfo getElementFactory()

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

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

the value of the VkImageViewUsageCreateInfo#pNext field.

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

Sets the specified value to the VkImageViewUsageCreateInfo#pNext field.

selfback to summary
protected VkImageViewUsageCreateInfo.Buffer self()

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

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

the value of the VkImageViewUsageCreateInfo#sType field.

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

Sets the specified value to the VkImageViewUsageCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO value to the VkImageViewUsageCreateInfo#sType field.

usageback to summary
public int usage()
Returns:int

the value of the VkImageViewUsageCreateInfo#usage field.

Annotations
@NativeType:VkImageUsageFlags
usageback to summary
public VkImageViewUsageCreateInfo.Buffer usage(int value)

Sets the specified value to the VkImageViewUsageCreateInfo#usage field.