Package org.lwjgl.vulkan

Class VkClearValue

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkClearValue
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying a clear value.
    Description

    This union is used where part of the API requires either color or depth/stencil clear values, depending on the attachment, and defines the initial clear values in the VkRenderPassBeginInfo structure.

    See Also

    VkClearAttachment, VkClearColorValue, VkClearDepthStencilValue, VkRenderPassBeginInfo

    Member documentation

    • color – specifies the color image clear values to use when clearing a color image or attachment.
    • depthStencil – specifies the depth and stencil clear values to use when clearing a depth/stencil image or attachment.

    Layout

    
 union VkClearValue {
     VkClearColorValue color;
     VkClearDepthStencilValue depthStencil;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • COLOR, DEPTHSTENCIL

        The struct member offsets.

    • Constructor Detail

      • VkClearValue

        public VkClearValue​(java.nio.ByteBuffer container)
        Creates a VkClearValue 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

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • color

        public VkClearValue color​(java.util.function.Consumer<VkClearColorValue> consumer)
        Passes the color field to the specified Consumer.

      • set

        public VkClearValue set​(VkClearValue src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct

      • malloc

        public static VkClearValue malloc()
        Returns a new VkClearValue instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkClearValue calloc()
        Returns a new VkClearValue instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkClearValue create()
        Returns a new VkClearValue instance allocated with BufferUtils.

      • create

        public static VkClearValue create​(long address)
        Returns a new VkClearValue instance for the specified memory address.

      • createSafe

        @Nullable
public static VkClearValue createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

        public static VkClearValue.Buffer malloc​(int capacity)
        Returns a new VkClearValue.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • calloc

        public static VkClearValue.Buffer calloc​(int capacity)
        Returns a new VkClearValue.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • create

        public static VkClearValue.Buffer create​(long address,
                                         int capacity)
        Create a VkClearValue.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity

      • createSafe

        @Nullable
public static VkClearValue.Buffer createSafe​(long address,
                                             int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        public static VkClearValue mallocStack()
        Returns a new VkClearValue instance allocated on the thread-local MemoryStack.

      • callocStack

        public static VkClearValue callocStack()
        Returns a new VkClearValue instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

      • mallocStack

        public static VkClearValue mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkClearValue instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

        public static VkClearValue callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkClearValue instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • mallocStack

        public static VkClearValue.Buffer mallocStack​(int capacity)
        Returns a new VkClearValue.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity

      • callocStack

        public static VkClearValue.Buffer callocStack​(int capacity)
        Returns a new VkClearValue.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity

      • mallocStack

        public static VkClearValue.Buffer mallocStack​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new VkClearValue.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • callocStack

        public static VkClearValue.Buffer callocStack​(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
        Returns a new VkClearValue.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity