org.lwjgl.vulkan.VkClearRect

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkClearRect extends Struct<VkClearRect> implements NativeResource


 struct VkClearRect {
     {@link VkRect2D VkRect2D} rect;
     uint32_t baseArrayLayer;
     uint32_t layerCount;
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkClearRect.Buffer

An array of VkClearRect structs.

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

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

BASEARRAYLAYER

The struct member offsets.

static final int

LAYERCOUNT

The struct member offsets.

static final int

RECT

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkClearRect(ByteBuffer container)

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

Modifier and Type

Method

Description

int

baseArrayLayer()

VkClearRect

baseArrayLayer(int value)

Sets the specified value to the baseArrayLayer field.

static VkClearRect

calloc()

Returns a new VkClearRect instance allocated with memCalloc.

static VkClearRect.Buffer

calloc(int capacity)

Returns a new VkClearRect.Buffer instance allocated with memCalloc.

static VkClearRect.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkClearRect

calloc(MemoryStack stack)

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

static VkClearRect

callocStack()

Deprecated.

static VkClearRect.Buffer

callocStack(int capacity)

Deprecated.

static VkClearRect.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static VkClearRect

callocStack(MemoryStack stack)

Deprecated.

static VkClearRect

create()

Returns a new VkClearRect instance allocated with BufferUtils.

static VkClearRect.Buffer

create(int capacity)

Returns a new VkClearRect.Buffer instance allocated with BufferUtils.

static VkClearRect

create(long address)

Returns a new VkClearRect instance for the specified memory address.

static VkClearRect.Buffer

create(long address, int capacity)

Create a VkClearRect.Buffer instance at the specified memory.

static @Nullable VkClearRect

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkClearRect.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

layerCount()

VkClearRect

layerCount(int value)

Sets the specified value to the layerCount field.

static VkClearRect

malloc()

Returns a new VkClearRect instance allocated with memAlloc.

static VkClearRect.Buffer

malloc(int capacity)

Returns a new VkClearRect.Buffer instance allocated with memAlloc.

static VkClearRect.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkClearRect

malloc(MemoryStack stack)

Returns a new VkClearRect instance allocated on the specified MemoryStack.

static VkClearRect

mallocStack()

Deprecated.

static VkClearRect.Buffer

mallocStack(int capacity)

Deprecated.

static VkClearRect.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static VkClearRect

mallocStack(MemoryStack stack)

Deprecated.

static int

nbaseArrayLayer(long struct)

Unsafe version of baseArrayLayer().

static void

nbaseArrayLayer(long struct, int value)

Unsafe version of baseArrayLayer.

static int

nlayerCount(long struct)

Unsafe version of layerCount().

static void

nlayerCount(long struct, int value)

Unsafe version of layerCount.

static VkRect2D

nrect(long struct)

Unsafe version of rect().

static void

nrect(long struct, VkRect2D value)

Unsafe version of rect.

VkRect2D

rect()

VkClearRect

rect(Consumer<VkRect2D> consumer)

Passes the rect field to the specified Consumer.

VkClearRect

rect(VkRect2D value)

Copies the specified VkRect2D to the rect field.

VkClearRect

set(VkClearRect src)

Copies the specified struct data to this struct.

VkClearRect

set(VkRect2D rect, int baseArrayLayer, int layerCount)

Initializes this struct with the specified values.

int

sizeof()

Returns sizeof(struct).

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.
- RECT
  
  public static final int RECT
  
  The struct member offsets.
- BASEARRAYLAYER
  
  public static final int BASEARRAYLAYER
  
  The struct member offsets.
- LAYERCOUNT
  
  public static final int LAYERCOUNT
  
  The struct member offsets.
Constructor Details
- VkClearRect
  
  public VkClearRect(ByteBuffer container)
  
  Creates a VkClearRect 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<VkClearRect>
- rect
  
  public VkRect2D rect()
  
  Returns:
  
  a VkRect2D view of the rect field.
- baseArrayLayer
  
  public int baseArrayLayer()
  
  Returns:
  
  the value of the baseArrayLayer field.
- layerCount
  
  public int layerCount()
  
  Returns:
  
  the value of the layerCount field.
- rect
  
  public VkClearRect rect(VkRect2D value)
  
  Copies the specified VkRect2D to the rect field.
- rect
  
  public VkClearRect rect(Consumer<VkRect2D> consumer)
  
  Passes the rect field to the specified Consumer.
- baseArrayLayer
  
  public VkClearRect baseArrayLayer(int value)
  
  Sets the specified value to the baseArrayLayer field.
- layerCount
  
  public VkClearRect layerCount(int value)
  
  Sets the specified value to the layerCount field.
- set
  
  public VkClearRect set(VkRect2D rect, int baseArrayLayer, int layerCount)
  
  Initializes this struct with the specified values.
- set
  
  public VkClearRect set(VkClearRect src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkClearRect malloc()
  
  Returns a new VkClearRect instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkClearRect calloc()
  
  Returns a new VkClearRect instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkClearRect create()
  
  Returns a new VkClearRect instance allocated with BufferUtils.
- create
  
  public static VkClearRect create(long address)
  
  Returns a new VkClearRect instance for the specified memory address.
- createSafe
  
  public static @Nullable VkClearRect createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkClearRect.Buffer malloc(int capacity)
  
  Returns a new VkClearRect.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkClearRect.Buffer calloc(int capacity)
  
  Returns a new VkClearRect.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkClearRect.Buffer create(int capacity)
  
  Returns a new VkClearRect.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkClearRect.Buffer create(long address, int capacity)
  
  Create a VkClearRect.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkClearRect.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static VkClearRect mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkClearRect callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkClearRect mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkClearRect callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkClearRect.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkClearRect.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkClearRect.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkClearRect.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkClearRect malloc(MemoryStack stack)
  
  Returns a new VkClearRect instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkClearRect calloc(MemoryStack stack)
  
  Returns a new VkClearRect instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkClearRect.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkClearRect.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkClearRect.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkClearRect.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
- nrect
  
  public static VkRect2D nrect(long struct)
  
  Unsafe version of rect().
- nbaseArrayLayer
  
  public static int nbaseArrayLayer(long struct)
  
  Unsafe version of baseArrayLayer().
- nlayerCount
  
  public static int nlayerCount(long struct)
  
  Unsafe version of layerCount().
- nrect
  
  public static void nrect(long struct, VkRect2D value)
  
  Unsafe version of rect.
- nbaseArrayLayer
  
  public static void nbaseArrayLayer(long struct, int value)
  
  Unsafe version of baseArrayLayer.
- nlayerCount
  
  public static void nlayerCount(long struct, int value)
  
  Unsafe version of layerCount.

Class VkClearRect

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

RECT

BASEARRAYLAYER

LAYERCOUNT

Constructor Details

VkClearRect

Method Details

sizeof

rect

baseArrayLayer

layerCount

rect

rect

baseArrayLayer

layerCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nrect

nbaseArrayLayer

nlayerCount

nrect

nbaseArrayLayer

nlayerCount