org.lwjgl.vulkan.VkImageViewCreateInfo

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkImageViewCreateInfo extends Struct<VkImageViewCreateInfo> implements NativeResource

struct VkImageViewCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkImageViewCreateFlags flags;
    VkImage image;
    VkImageViewType viewType;
    VkFormat format;
    VkComponentMapping components;
    VkImageSubresourceRange subresourceRange;
}

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkImageViewCreateInfo.Buffer

An array of VkImageViewCreateInfo structs.

Nested classes/interfaces inherited from class Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

COMPONENTS

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

FORMAT

The struct member offsets.

static final int

IMAGE

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.

static final int

SUBRESOURCERANGE

The struct member offsets.

static final int

VIEWTYPE

The struct member offsets.

Fields inherited from interface Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkImageViewCreateInfo(ByteBuffer container)

Creates a VkImageViewCreateInfo instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VkImageViewCreateInfo

calloc()

Returns a new VkImageViewCreateInfo instance allocated with memCalloc.

static VkImageViewCreateInfo.Buffer

calloc(int capacity)

Returns a new VkImageViewCreateInfo.Buffer instance allocated with memCalloc.

static VkImageViewCreateInfo.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkImageViewCreateInfo

calloc(MemoryStack stack)

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

VkComponentMapping

components()

VkImageViewCreateInfo

components(Consumer<VkComponentMapping> consumer)

Passes the components field to the specified Consumer.

VkImageViewCreateInfo

components(VkComponentMapping value)

Copies the specified VkComponentMapping to the components field.

static VkImageViewCreateInfo

create()

Returns a new VkImageViewCreateInfo instance allocated with BufferUtils.

static VkImageViewCreateInfo.Buffer

create(int capacity)

Returns a new VkImageViewCreateInfo.Buffer instance allocated with BufferUtils.

static VkImageViewCreateInfo

create(long address)

Returns a new VkImageViewCreateInfo instance for the specified memory address.

static VkImageViewCreateInfo.Buffer

create(long address, int capacity)

Create a VkImageViewCreateInfo.Buffer instance at the specified memory.

static @Nullable VkImageViewCreateInfo

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkImageViewCreateInfo.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

flags()

VkImageViewCreateInfo

flags(int value)

Sets the specified value to the flags field.

int

format()

VkImageViewCreateInfo

format(int value)

Sets the specified value to the format field.

long

image()

VkImageViewCreateInfo

image(long value)

Sets the specified value to the image field.

static VkImageViewCreateInfo

malloc()

Returns a new VkImageViewCreateInfo instance allocated with memAlloc.

static VkImageViewCreateInfo.Buffer

malloc(int capacity)

Returns a new VkImageViewCreateInfo.Buffer instance allocated with memAlloc.

static VkImageViewCreateInfo.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkImageViewCreateInfo

malloc(MemoryStack stack)

Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack.

static VkComponentMapping

ncomponents(long struct)

Unsafe version of components().

static void

ncomponents(long struct, VkComponentMapping value)

Unsafe version of components.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static int

nformat(long struct)

Unsafe version of format().

static void

nformat(long struct, int value)

Unsafe version of format.

static long

nimage(long struct)

Unsafe version of image().

static void

nimage(long struct, long value)

Unsafe version of image.

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.

static VkImageSubresourceRange

nsubresourceRange(long struct)

Unsafe version of subresourceRange().

static void

nsubresourceRange(long struct, VkImageSubresourceRange value)

Unsafe version of subresourceRange.

static int

nviewType(long struct)

Unsafe version of viewType().

static void

nviewType(long struct, int value)

Unsafe version of viewType.

long

pNext()

VkImageViewCreateInfo

pNext(long value)

Sets the specified value to the pNext field.

VkImageViewCreateInfo

pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewASTCDecodeModeEXT value)

Prepends the specified VkImageViewASTCDecodeModeEXT value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewMinLodCreateInfoEXT value)

Prepends the specified VkImageViewMinLodCreateInfoEXT value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewSampleWeightCreateInfoQCOM value)

Prepends the specified VkImageViewSampleWeightCreateInfoQCOM value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewSlicedCreateInfoEXT value)

Prepends the specified VkImageViewSlicedCreateInfoEXT value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewUsageCreateInfo value)

Prepends the specified VkImageViewUsageCreateInfo value to the pNext chain.

VkImageViewCreateInfo

pNext(VkImageViewUsageCreateInfoKHR value)

Prepends the specified VkImageViewUsageCreateInfoKHR value to the pNext chain.

VkImageViewCreateInfo

pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)

Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.

VkImageViewCreateInfo

pNext(VkSamplerYcbcrConversionInfo value)

Prepends the specified VkSamplerYcbcrConversionInfo value to the pNext chain.

VkImageViewCreateInfo

pNext(VkSamplerYcbcrConversionInfoKHR value)

Prepends the specified VkSamplerYcbcrConversionInfoKHR value to the pNext chain.

VkImageViewCreateInfo

set(int sType, long pNext, int flags, long image, int viewType, int format, VkComponentMapping components, VkImageSubresourceRange subresourceRange)

Initializes this struct with the specified values.

VkImageViewCreateInfo

set(VkImageViewCreateInfo src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

sType()

VkImageViewCreateInfo

sType(int value)

Sets the specified value to the sType field.

VkImageViewCreateInfo

sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO value to the sType field.

VkImageSubresourceRange

subresourceRange()

VkImageViewCreateInfo

subresourceRange(Consumer<VkImageSubresourceRange> consumer)

Passes the subresourceRange field to the specified Consumer.

VkImageViewCreateInfo

subresourceRange(VkImageSubresourceRange value)

Copies the specified VkImageSubresourceRange to the subresourceRange field.

int

viewType()

VkImageViewCreateInfo

viewType(int value)

Sets the specified value to the viewType field.

Methods inherited from class Struct
clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default
address, equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- IMAGE
  
  public static final int IMAGE
  
  The struct member offsets.
- VIEWTYPE
  
  public static final int VIEWTYPE
  
  The struct member offsets.
- FORMAT
  
  public static final int FORMAT
  
  The struct member offsets.
- COMPONENTS
  
  public static final int COMPONENTS
  
  The struct member offsets.
- SUBRESOURCERANGE
  
  public static final int SUBRESOURCERANGE
  
  The struct member offsets.
Constructor Details
- VkImageViewCreateInfo
  
  public VkImageViewCreateInfo(ByteBuffer container)
  
  Creates a VkImageViewCreateInfo 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()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VkImageViewCreateInfo>
- sType
  
  @NativeType("VkStructureType") public int sType()
  
  Returns:
  
  the value of the sType field.
- pNext
  
  @NativeType("void const *") public long pNext()
  
  Returns:
  
  the value of the pNext field.
- flags
  
  @NativeType("VkImageViewCreateFlags") public int flags()
  
  Returns:
  
  the value of the flags field.
- image
  
  @NativeType("VkImage") public long image()
  
  Returns:
  
  the value of the image field.
- viewType
  
  @NativeType("VkImageViewType") public int viewType()
  
  Returns:
  
  the value of the viewType field.
- format
  
  @NativeType("VkFormat") public int format()
  
  Returns:
  
  the value of the format field.
- components
  
  public VkComponentMapping components()
  
  Returns:
  
  a VkComponentMapping view of the components field.
- subresourceRange
  
  public VkImageSubresourceRange subresourceRange()
  
  Returns:
  
  a VkImageSubresourceRange view of the subresourceRange field.
- sType
  
  public VkImageViewCreateInfo sType(@NativeType("VkStructureType") int value)
  
  Sets the specified value to the sType field.
- sType$Default
  
  public VkImageViewCreateInfo sType$Default()
  
  Sets the STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO value to the sType field.
- pNext
  
  public VkImageViewCreateInfo pNext(@NativeType("void const *") long value)
  
  Sets the specified value to the pNext field.
- pNext
  
  public VkImageViewCreateInfo pNext(VkExportMetalObjectCreateInfoEXT value)
  
  Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewASTCDecodeModeEXT value)
  
  Prepends the specified VkImageViewASTCDecodeModeEXT value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewMinLodCreateInfoEXT value)
  
  Prepends the specified VkImageViewMinLodCreateInfoEXT value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewSampleWeightCreateInfoQCOM value)
  
  Prepends the specified VkImageViewSampleWeightCreateInfoQCOM value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewSlicedCreateInfoEXT value)
  
  Prepends the specified VkImageViewSlicedCreateInfoEXT value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewUsageCreateInfo value)
  
  Prepends the specified VkImageViewUsageCreateInfo value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkImageViewUsageCreateInfoKHR value)
  
  Prepends the specified VkImageViewUsageCreateInfoKHR value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkOpaqueCaptureDescriptorDataCreateInfoEXT value)
  
  Prepends the specified VkOpaqueCaptureDescriptorDataCreateInfoEXT value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkSamplerYcbcrConversionInfo value)
  
  Prepends the specified VkSamplerYcbcrConversionInfo value to the pNext chain.
- pNext
  
  public VkImageViewCreateInfo pNext(VkSamplerYcbcrConversionInfoKHR value)
  
  Prepends the specified VkSamplerYcbcrConversionInfoKHR value to the pNext chain.
- flags
  
  public VkImageViewCreateInfo flags(@NativeType("VkImageViewCreateFlags") int value)
  
  Sets the specified value to the flags field.
- image
  
  public VkImageViewCreateInfo image(@NativeType("VkImage") long value)
  
  Sets the specified value to the image field.
- viewType
  
  public VkImageViewCreateInfo viewType(@NativeType("VkImageViewType") int value)
  
  Sets the specified value to the viewType field.
- format
  
  public VkImageViewCreateInfo format(@NativeType("VkFormat") int value)
  
  Sets the specified value to the format field.
- components
  
  public VkImageViewCreateInfo components(VkComponentMapping value)
  
  Copies the specified VkComponentMapping to the components field.
- components
  
  public VkImageViewCreateInfo components(Consumer<VkComponentMapping> consumer)
  
  Passes the components field to the specified Consumer.
- subresourceRange
  
  public VkImageViewCreateInfo subresourceRange(VkImageSubresourceRange value)
  
  Copies the specified VkImageSubresourceRange to the subresourceRange field.
- subresourceRange
  
  public VkImageViewCreateInfo subresourceRange(Consumer<VkImageSubresourceRange> consumer)
  
  Passes the subresourceRange field to the specified Consumer.
- set
  
  public VkImageViewCreateInfo set(int sType, long pNext, int flags, long image, int viewType, int format, VkComponentMapping components, VkImageSubresourceRange subresourceRange)
  
  Initializes this struct with the specified values.
- set
  
  public VkImageViewCreateInfo set(VkImageViewCreateInfo src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkImageViewCreateInfo malloc()
  
  Returns a new VkImageViewCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkImageViewCreateInfo calloc()
  
  Returns a new VkImageViewCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkImageViewCreateInfo create()
  
  Returns a new VkImageViewCreateInfo instance allocated with BufferUtils.
- create
  
  public static VkImageViewCreateInfo create(long address)
  
  Returns a new VkImageViewCreateInfo instance for the specified memory address.
- createSafe
  
  public static @Nullable VkImageViewCreateInfo createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageViewCreateInfo.Buffer malloc(int capacity)
  
  Returns a new VkImageViewCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkImageViewCreateInfo.Buffer calloc(int capacity)
  
  Returns a new VkImageViewCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageViewCreateInfo.Buffer create(int capacity)
  
  Returns a new VkImageViewCreateInfo.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkImageViewCreateInfo.Buffer create(long address, int capacity)
  
  Create a VkImageViewCreateInfo.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkImageViewCreateInfo.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkImageViewCreateInfo malloc(MemoryStack stack)
  
  Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageViewCreateInfo calloc(MemoryStack stack)
  
  Returns a new VkImageViewCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkImageViewCreateInfo.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkImageViewCreateInfo.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkImageViewCreateInfo.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkImageViewCreateInfo.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().
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nimage
  
  public static long nimage(long struct)
  
  Unsafe version of image().
- nviewType
  
  public static int nviewType(long struct)
  
  Unsafe version of viewType().
- nformat
  
  public static int nformat(long struct)
  
  Unsafe version of format().
- ncomponents
  
  public static VkComponentMapping ncomponents(long struct)
  
  Unsafe version of components().
- nsubresourceRange
  
  public static VkImageSubresourceRange nsubresourceRange(long struct)
  
  Unsafe version of subresourceRange().
- 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.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nimage
  
  public static void nimage(long struct, long value)
  
  Unsafe version of image.
- nviewType
  
  public static void nviewType(long struct, int value)
  
  Unsafe version of viewType.
- nformat
  
  public static void nformat(long struct, int value)
  
  Unsafe version of format.
- ncomponents
  
  public static void ncomponents(long struct, VkComponentMapping value)
  
  Unsafe version of components.
- nsubresourceRange
  
  public static void nsubresourceRange(long struct, VkImageSubresourceRange value)
  
  Unsafe version of subresourceRange.

Class VkImageViewCreateInfo

Nested Class Summary

Nested classes/interfaces inherited from class Struct

Nested classes/interfaces inherited from interface Pointer

Field Summary

Fields inherited from interface Pointer

Constructor Summary

Method Summary

Methods inherited from class Struct

Methods inherited from class Pointer.Default

Methods inherited from class Object

Methods inherited from interface NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

IMAGE

VIEWTYPE

FORMAT

COMPONENTS

SUBRESOURCERANGE

Constructor Details

VkImageViewCreateInfo

Method Details

sizeof

sType

pNext

flags

image

viewType

format

components

subresourceRange

sType

sType$Default

pNext

pNext

pNext

pNext

pNext

pNext

pNext

pNext

pNext

pNext

pNext

flags

image

viewType

format

components

components

subresourceRange

subresourceRange

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nimage

nviewType

nformat

ncomponents

nsubresourceRange