org.lwjgl.vulkan.VkComponentMapping 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 a color component mapping.
*
* Valid Usage (Implicit)
*
*
* - {@code r} must be a valid {@code VkComponentSwizzle} value
* - {@code g} must be a valid {@code VkComponentSwizzle} value
* - {@code b} must be a valid {@code VkComponentSwizzle} value
* - {@code a} must be a valid {@code VkComponentSwizzle} value
*
*
* See Also
*
* {@link VkImageViewCreateInfo}, {@link VkSamplerBorderColorComponentMappingCreateInfoEXT}, {@link VkSamplerYcbcrConversionCreateInfo}
*
* Layout
*
*
* struct VkComponentMapping {
* VkComponentSwizzle {@link #r};
* VkComponentSwizzle {@link #g};
* VkComponentSwizzle {@link #b};
* VkComponentSwizzle {@link #a};
* }
*/
public class VkComponentMapping 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
R,
G,
B,
A;
static {
Layout layout = __struct(
__member(4),
__member(4),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
R = layout.offsetof(0);
G = layout.offsetof(1);
B = layout.offsetof(2);
A = layout.offsetof(3);
}
/**
* Creates a {@code VkComponentMapping} 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 VkComponentMapping(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** a {@code VkComponentSwizzle} specifying the component value placed in the R component of the output vector. */
@NativeType("VkComponentSwizzle")
public int r() { return nr(address()); }
/** a {@code VkComponentSwizzle} specifying the component value placed in the G component of the output vector. */
@NativeType("VkComponentSwizzle")
public int g() { return ng(address()); }
/** a {@code VkComponentSwizzle} specifying the component value placed in the B component of the output vector. */
@NativeType("VkComponentSwizzle")
public int b() { return nb(address()); }
/** a {@code VkComponentSwizzle} specifying the component value placed in the A component of the output vector. */
@NativeType("VkComponentSwizzle")
public int a() { return na(address()); }
/** Sets the specified value to the {@link #r} field. */
public VkComponentMapping r(@NativeType("VkComponentSwizzle") int value) { nr(address(), value); return this; }
/** Sets the specified value to the {@link #g} field. */
public VkComponentMapping g(@NativeType("VkComponentSwizzle") int value) { ng(address(), value); return this; }
/** Sets the specified value to the {@link #b} field. */
public VkComponentMapping b(@NativeType("VkComponentSwizzle") int value) { nb(address(), value); return this; }
/** Sets the specified value to the {@link #a} field. */
public VkComponentMapping a(@NativeType("VkComponentSwizzle") int value) { na(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkComponentMapping set(
int r,
int g,
int b,
int a
) {
r(r);
g(g);
b(b);
a(a);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkComponentMapping set(VkComponentMapping src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkComponentMapping} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkComponentMapping malloc() {
return wrap(VkComponentMapping.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkComponentMapping} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkComponentMapping calloc() {
return wrap(VkComponentMapping.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkComponentMapping} instance allocated with {@link BufferUtils}. */
public static VkComponentMapping create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkComponentMapping.class, memAddress(container), container);
}
/** Returns a new {@code VkComponentMapping} instance for the specified memory address. */
public static VkComponentMapping create(long address) {
return wrap(VkComponentMapping.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkComponentMapping createSafe(long address) {
return address == NULL ? null : wrap(VkComponentMapping.class, address);
}
/**
* Returns a new {@link VkComponentMapping.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkComponentMapping.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkComponentMapping.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkComponentMapping.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkComponentMapping.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkComponentMapping.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkComponentMapping.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkComponentMapping.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 VkComponentMapping.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkComponentMapping mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkComponentMapping callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkComponentMapping mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkComponentMapping callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkComponentMapping.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkComponentMapping.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkComponentMapping.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkComponentMapping.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkComponentMapping} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkComponentMapping malloc(MemoryStack stack) {
return wrap(VkComponentMapping.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkComponentMapping} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkComponentMapping calloc(MemoryStack stack) {
return wrap(VkComponentMapping.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkComponentMapping.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkComponentMapping.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkComponentMapping.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 VkComponentMapping.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #r}. */
public static int nr(long struct) { return UNSAFE.getInt(null, struct + VkComponentMapping.R); }
/** Unsafe version of {@link #g}. */
public static int ng(long struct) { return UNSAFE.getInt(null, struct + VkComponentMapping.G); }
/** Unsafe version of {@link #b}. */
public static int nb(long struct) { return UNSAFE.getInt(null, struct + VkComponentMapping.B); }
/** Unsafe version of {@link #a}. */
public static int na(long struct) { return UNSAFE.getInt(null, struct + VkComponentMapping.A); }
/** Unsafe version of {@link #r(int) r}. */
public static void nr(long struct, int value) { UNSAFE.putInt(null, struct + VkComponentMapping.R, value); }
/** Unsafe version of {@link #g(int) g}. */
public static void ng(long struct, int value) { UNSAFE.putInt(null, struct + VkComponentMapping.G, value); }
/** Unsafe version of {@link #b(int) b}. */
public static void nb(long struct, int value) { UNSAFE.putInt(null, struct + VkComponentMapping.B, value); }
/** Unsafe version of {@link #a(int) a}. */
public static void na(long struct, int value) { UNSAFE.putInt(null, struct + VkComponentMapping.A, value); }
// -----------------------------------
/** An array of {@link VkComponentMapping} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkComponentMapping ELEMENT_FACTORY = VkComponentMapping.create(-1L);
/**
* Creates a new {@code VkComponentMapping.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 VkComponentMapping#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 VkComponentMapping getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkComponentMapping#r} field. */
@NativeType("VkComponentSwizzle")
public int r() { return VkComponentMapping.nr(address()); }
/** @return the value of the {@link VkComponentMapping#g} field. */
@NativeType("VkComponentSwizzle")
public int g() { return VkComponentMapping.ng(address()); }
/** @return the value of the {@link VkComponentMapping#b} field. */
@NativeType("VkComponentSwizzle")
public int b() { return VkComponentMapping.nb(address()); }
/** @return the value of the {@link VkComponentMapping#a} field. */
@NativeType("VkComponentSwizzle")
public int a() { return VkComponentMapping.na(address()); }
/** Sets the specified value to the {@link VkComponentMapping#r} field. */
public VkComponentMapping.Buffer r(@NativeType("VkComponentSwizzle") int value) { VkComponentMapping.nr(address(), value); return this; }
/** Sets the specified value to the {@link VkComponentMapping#g} field. */
public VkComponentMapping.Buffer g(@NativeType("VkComponentSwizzle") int value) { VkComponentMapping.ng(address(), value); return this; }
/** Sets the specified value to the {@link VkComponentMapping#b} field. */
public VkComponentMapping.Buffer b(@NativeType("VkComponentSwizzle") int value) { VkComponentMapping.nb(address(), value); return this; }
/** Sets the specified value to the {@link VkComponentMapping#a} field. */
public VkComponentMapping.Buffer a(@NativeType("VkComponentSwizzle") int value) { VkComponentMapping.na(address(), value); return this; }
}
}