org.lwjgl.vulkan.VkDrmFormatModifierPropertiesEXT Maven / Gradle / Ivy
Show all versions of lwjgl-vulkan Show documentation
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* Structure specifying properties of a format when combined with a DRM format modifier.
*
* Description
*
* The returned {@code drmFormatModifierTilingFeatures} must contain at least one bit.
*
* The implementation must not return {@code DRM_FORMAT_MOD_INVALID} in {@code drmFormatModifier}.
*
* An image’s memory planecount (as returned by {@code drmFormatModifierPlaneCount}) is distinct from its format planecount (in the sense of multi-planar Y′CBCR formats). In {@code VkImageAspectFlags}, each VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT represents a memory plane and each VK_IMAGE_ASPECT_PLANE_i_BIT a format plane.
*
* An image’s set of format planes is an ordered partition of the image’s content into separable groups of format components. The ordered partition is encoded in the name of each {@code VkFormat}. For example, {@link VK11#VK_FORMAT_G8_B8R8_2PLANE_420_UNORM FORMAT_G8_B8R8_2PLANE_420_UNORM} contains two format planes; the first plane contains the green component and the second plane contains the blue component and red component. If the format name does not contain {@code PLANE}, then the format contains a single plane; for example, {@link VK10#VK_FORMAT_R8G8B8A8_UNORM FORMAT_R8G8B8A8_UNORM}. Some commands, such as {@link VK10#vkCmdCopyBufferToImage CmdCopyBufferToImage}, do not operate on all format components in the image, but instead operate only on the format planes explicitly chosen by the application and operate on each format plane independently.
*
* An image’s set of memory planes is an ordered partition of the image’s memory rather than the image’s content. Each memory plane is a contiguous range of memory. The union of an image’s memory planes is not necessarily contiguous.
*
* If an image is linear, then the partition is the same for memory planes and for format planes. Therefore, if the returned {@code drmFormatModifier} is {@code DRM_FORMAT_MOD_LINEAR}, then {@code drmFormatModifierPlaneCount} must equal the format planecount, and {@code drmFormatModifierTilingFeatures} must be identical to the {@link VkFormatProperties2}{@code ::linearTilingFeatures} returned in the same {@code pNext} chain.
*
* If an image is non-linear, then the partition of the image’s memory into memory planes is implementation-specific and may be unrelated to the partition of the image’s content into format planes. For example, consider an image whose {@code format} is {@link VK11#VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM FORMAT_G8_B8_R8_3PLANE_420_UNORM}, {@code tiling} is {@link EXTImageDrmFormatModifier#VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT}, whose {@code drmFormatModifier} is not {@code DRM_FORMAT_MOD_LINEAR}, and {@code flags} lacks {@link VK11#VK_IMAGE_CREATE_DISJOINT_BIT IMAGE_CREATE_DISJOINT_BIT}. The image has 3 format planes, and commands such {@link VK10#vkCmdCopyBufferToImage CmdCopyBufferToImage} act on each format plane independently as if the data of each format plane were separable from the data of the other planes. In a straightforward implementation, the implementation may store the image’s content in 3 adjacent memory planes where each memory plane corresponds exactly to a format plane. However, the implementation may also store the image’s content in a single memory plane where all format components are combined using an implementation-private block-compressed format; or the implementation may store the image’s content in a collection of 7 adjacent memory planes using an implementation-private sharding technique. Because the image is non-linear and non-disjoint, the implementation has much freedom when choosing the image’s placement in memory.
*
* The memory planecount applies to function parameters and structures only when the API specifies an explicit requirement on {@code drmFormatModifierPlaneCount}. In all other cases, the memory planecount is ignored.
*
* See Also
*
* {@link VkDrmFormatModifierPropertiesListEXT}
*
* Layout
*
*
* struct VkDrmFormatModifierPropertiesEXT {
* uint64_t {@link #drmFormatModifier};
* uint32_t {@link #drmFormatModifierPlaneCount};
* VkFormatFeatureFlags {@link #drmFormatModifierTilingFeatures};
* }
*/
public class VkDrmFormatModifierPropertiesEXT extends Struct {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
DRMFORMATMODIFIER,
DRMFORMATMODIFIERPLANECOUNT,
DRMFORMATMODIFIERTILINGFEATURES;
static {
Layout layout = __struct(
__member(8),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
DRMFORMATMODIFIER = layout.offsetof(0);
DRMFORMATMODIFIERPLANECOUNT = layout.offsetof(1);
DRMFORMATMODIFIERTILINGFEATURES = layout.offsetof(2);
}
/**
* Creates a {@code VkDrmFormatModifierPropertiesEXT} instance at the current position of the specified {@link 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.
*/
public VkDrmFormatModifierPropertiesEXT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** a Linux DRM format modifier. */
@NativeType("uint64_t")
public long drmFormatModifier() { return ndrmFormatModifier(address()); }
/** the number of memory planes in any image created with {@code format} and {@code drmFormatModifier}. An image’s memory planecount is distinct from its format planecount, as explained below. */
@NativeType("uint32_t")
public int drmFormatModifierPlaneCount() { return ndrmFormatModifierPlaneCount(address()); }
/** a bitmask of {@code VkFormatFeatureFlagBits} that are supported by any image created with {@code format} and {@code drmFormatModifier}. */
@NativeType("VkFormatFeatureFlags")
public int drmFormatModifierTilingFeatures() { return ndrmFormatModifierTilingFeatures(address()); }
// -----------------------------------
/** Returns a new {@code VkDrmFormatModifierPropertiesEXT} instance for the specified memory address. */
public static VkDrmFormatModifierPropertiesEXT create(long address) {
return wrap(VkDrmFormatModifierPropertiesEXT.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDrmFormatModifierPropertiesEXT createSafe(long address) {
return address == NULL ? null : wrap(VkDrmFormatModifierPropertiesEXT.class, address);
}
/**
* Create a {@link VkDrmFormatModifierPropertiesEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkDrmFormatModifierPropertiesEXT.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDrmFormatModifierPropertiesEXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Unsafe version of {@link #drmFormatModifier}. */
public static long ndrmFormatModifier(long struct) { return UNSAFE.getLong(null, struct + VkDrmFormatModifierPropertiesEXT.DRMFORMATMODIFIER); }
/** Unsafe version of {@link #drmFormatModifierPlaneCount}. */
public static int ndrmFormatModifierPlaneCount(long struct) { return UNSAFE.getInt(null, struct + VkDrmFormatModifierPropertiesEXT.DRMFORMATMODIFIERPLANECOUNT); }
/** Unsafe version of {@link #drmFormatModifierTilingFeatures}. */
public static int ndrmFormatModifierTilingFeatures(long struct) { return UNSAFE.getInt(null, struct + VkDrmFormatModifierPropertiesEXT.DRMFORMATMODIFIERTILINGFEATURES); }
// -----------------------------------
/** An array of {@link VkDrmFormatModifierPropertiesEXT} structs. */
public static class Buffer extends StructBuffer {
private static final VkDrmFormatModifierPropertiesEXT ELEMENT_FACTORY = VkDrmFormatModifierPropertiesEXT.create(-1L);
/**
* Creates a new {@code VkDrmFormatModifierPropertiesEXT.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 {@link VkDrmFormatModifierPropertiesEXT#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected VkDrmFormatModifierPropertiesEXT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkDrmFormatModifierPropertiesEXT#drmFormatModifier} field. */
@NativeType("uint64_t")
public long drmFormatModifier() { return VkDrmFormatModifierPropertiesEXT.ndrmFormatModifier(address()); }
/** @return the value of the {@link VkDrmFormatModifierPropertiesEXT#drmFormatModifierPlaneCount} field. */
@NativeType("uint32_t")
public int drmFormatModifierPlaneCount() { return VkDrmFormatModifierPropertiesEXT.ndrmFormatModifierPlaneCount(address()); }
/** @return the value of the {@link VkDrmFormatModifierPropertiesEXT#drmFormatModifierTilingFeatures} field. */
@NativeType("VkFormatFeatureFlags")
public int drmFormatModifierTilingFeatures() { return VkDrmFormatModifierPropertiesEXT.ndrmFormatModifierTilingFeatures(address()); }
}
}