org.lwjgl.vulkan.VkFormatProperties3KHR Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* 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.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying image format properties.
*
* Description
*
* The bits reported in {@code linearTilingFeatures}, {@code optimalTilingFeatures} and {@code bufferFeatures} must include the bits reported in the corresponding fields of {@link VkFormatProperties2}{@code ::formatProperties}.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHRFormatFeatureFlags2#VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR}
*
*
* Layout
*
*
* struct VkFormatProperties3KHR {
* VkStructureType sType;
* void * pNext;
* VkFormatFeatureFlags2KHR {@link #linearTilingFeatures};
* VkFormatFeatureFlags2KHR {@link #optimalTilingFeatures};
* VkFormatFeatureFlags2KHR {@link #bufferFeatures};
* }
*/
public class VkFormatProperties3KHR extends Struct implements NativeResource {
/** 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
STYPE,
PNEXT,
LINEARTILINGFEATURES,
OPTIMALTILINGFEATURES,
BUFFERFEATURES;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(8),
__member(8),
__member(8)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
LINEARTILINGFEATURES = layout.offsetof(2);
OPTIMALTILINGFEATURES = layout.offsetof(3);
BUFFERFEATURES = layout.offsetof(4);
}
/**
* Creates a {@code VkFormatProperties3KHR} 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 VkFormatProperties3KHR(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** @return the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** @return the value of the {@code pNext} field. */
@NativeType("void *")
public long pNext() { return npNext(address()); }
/** a bitmask of {@code VkFormatFeatureFlagBits2KHR} specifying features supported by images created with a {@code tiling} parameter of {@link VK10#VK_IMAGE_TILING_LINEAR IMAGE_TILING_LINEAR}. */
@NativeType("VkFormatFeatureFlags2KHR")
public long linearTilingFeatures() { return nlinearTilingFeatures(address()); }
/** a bitmask of {@code VkFormatFeatureFlagBits2KHR} specifying features supported by images created with a {@code tiling} parameter of {@link VK10#VK_IMAGE_TILING_OPTIMAL IMAGE_TILING_OPTIMAL}. */
@NativeType("VkFormatFeatureFlags2KHR")
public long optimalTilingFeatures() { return noptimalTilingFeatures(address()); }
/** a bitmask of {@code VkFormatFeatureFlagBits2KHR} specifying features supported by buffers. */
@NativeType("VkFormatFeatureFlags2KHR")
public long bufferFeatures() { return nbufferFeatures(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkFormatProperties3KHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the {@link KHRFormatFeatureFlags2#VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR} value to the {@code sType} field. */
public VkFormatProperties3KHR sType$Default() { return sType(KHRFormatFeatureFlags2.VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR); }
/** Sets the specified value to the {@code pNext} field. */
public VkFormatProperties3KHR pNext(@NativeType("void *") long value) { npNext(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkFormatProperties3KHR set(
int sType,
long pNext
) {
sType(sType);
pNext(pNext);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkFormatProperties3KHR set(VkFormatProperties3KHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkFormatProperties3KHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkFormatProperties3KHR malloc() {
return wrap(VkFormatProperties3KHR.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkFormatProperties3KHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkFormatProperties3KHR calloc() {
return wrap(VkFormatProperties3KHR.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkFormatProperties3KHR} instance allocated with {@link BufferUtils}. */
public static VkFormatProperties3KHR create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkFormatProperties3KHR.class, memAddress(container), container);
}
/** Returns a new {@code VkFormatProperties3KHR} instance for the specified memory address. */
public static VkFormatProperties3KHR create(long address) {
return wrap(VkFormatProperties3KHR.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkFormatProperties3KHR createSafe(long address) {
return address == NULL ? null : wrap(VkFormatProperties3KHR.class, address);
}
/**
* Returns a new {@link VkFormatProperties3KHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkFormatProperties3KHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkFormatProperties3KHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkFormatProperties3KHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.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 VkFormatProperties3KHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VkFormatProperties3KHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkFormatProperties3KHR malloc(MemoryStack stack) {
return wrap(VkFormatProperties3KHR.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkFormatProperties3KHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkFormatProperties3KHR calloc(MemoryStack stack) {
return wrap(VkFormatProperties3KHR.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkFormatProperties3KHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkFormatProperties3KHR.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkFormatProperties3KHR.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return UNSAFE.getInt(null, struct + VkFormatProperties3KHR.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkFormatProperties3KHR.PNEXT); }
/** Unsafe version of {@link #linearTilingFeatures}. */
public static long nlinearTilingFeatures(long struct) { return UNSAFE.getLong(null, struct + VkFormatProperties3KHR.LINEARTILINGFEATURES); }
/** Unsafe version of {@link #optimalTilingFeatures}. */
public static long noptimalTilingFeatures(long struct) { return UNSAFE.getLong(null, struct + VkFormatProperties3KHR.OPTIMALTILINGFEATURES); }
/** Unsafe version of {@link #bufferFeatures}. */
public static long nbufferFeatures(long struct) { return UNSAFE.getLong(null, struct + VkFormatProperties3KHR.BUFFERFEATURES); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { UNSAFE.putInt(null, struct + VkFormatProperties3KHR.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkFormatProperties3KHR.PNEXT, value); }
// -----------------------------------
/** An array of {@link VkFormatProperties3KHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkFormatProperties3KHR ELEMENT_FACTORY = VkFormatProperties3KHR.create(-1L);
/**
* Creates a new {@code VkFormatProperties3KHR.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 VkFormatProperties3KHR#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 VkFormatProperties3KHR getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkFormatProperties3KHR.nsType(address()); }
/** @return the value of the {@code pNext} field. */
@NativeType("void *")
public long pNext() { return VkFormatProperties3KHR.npNext(address()); }
/** @return the value of the {@link VkFormatProperties3KHR#linearTilingFeatures} field. */
@NativeType("VkFormatFeatureFlags2KHR")
public long linearTilingFeatures() { return VkFormatProperties3KHR.nlinearTilingFeatures(address()); }
/** @return the value of the {@link VkFormatProperties3KHR#optimalTilingFeatures} field. */
@NativeType("VkFormatFeatureFlags2KHR")
public long optimalTilingFeatures() { return VkFormatProperties3KHR.noptimalTilingFeatures(address()); }
/** @return the value of the {@link VkFormatProperties3KHR#bufferFeatures} field. */
@NativeType("VkFormatFeatureFlags2KHR")
public long bufferFeatures() { return VkFormatProperties3KHR.nbufferFeatures(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkFormatProperties3KHR.Buffer sType(@NativeType("VkStructureType") int value) { VkFormatProperties3KHR.nsType(address(), value); return this; }
/** Sets the {@link KHRFormatFeatureFlags2#VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR} value to the {@code sType} field. */
public VkFormatProperties3KHR.Buffer sType$Default() { return sType(KHRFormatFeatureFlags2.VK_STRUCTURE_TYPE_FORMAT_PROPERTIES_3_KHR); }
/** Sets the specified value to the {@code pNext} field. */
public VkFormatProperties3KHR.Buffer pNext(@NativeType("void *") long value) { VkFormatProperties3KHR.npNext(address(), value); return this; }
}
}