org.lwjgl.vulkan.VkDebugMarkerMarkerInfoEXT 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Specify parameters of a command buffer marker region.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link EXTDebugMarker#VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT}
* - {@code pNext} must be {@code NULL}
* - {@code pMarkerName} must be a null-terminated UTF-8 string
*
*
* See Also
*
* {@link EXTDebugMarker#vkCmdDebugMarkerBeginEXT CmdDebugMarkerBeginEXT}, {@link EXTDebugMarker#vkCmdDebugMarkerInsertEXT CmdDebugMarkerInsertEXT}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code pMarkerName} – a pointer to a null-terminated UTF-8 string that contains the name of the marker.
* - {@code color} – an optional: RGBA color value that can be associated with the marker. A particular implementation may choose to ignore this color value. The values contain RGBA values in order, in the range 0.0 to 1.0. If all elements in {@code color} are set to 0.0 then it is ignored.
*
*
* Layout
*
*
* struct VkDebugMarkerMarkerInfoEXT {
* VkStructureType sType;
* const void * pNext;
* const char * pMarkerName;
* float color[4];
* }The created instance holds a strong reference to the container object.
*/
public VkDebugMarkerMarkerInfoEXT(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pMarkerName} field. */
@NativeType("const char *")
public ByteBuffer pMarkerName() { return npMarkerName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pMarkerName} field. */
@NativeType("const char *")
public String pMarkerNameString() { return npMarkerNameString(address()); }
/** Returns a {@link FloatBuffer} view of the {@code color} field. */
@NativeType("float[4]")
public FloatBuffer color() { return ncolor(address()); }
/** Returns the value at the specified index of the {@code color} field. */
public float color(int index) { return ncolor(address(), index); }
/** Sets the specified value to the {@code sType} field. */
public VkDebugMarkerMarkerInfoEXT sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkDebugMarkerMarkerInfoEXT pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pMarkerName} field. */
public VkDebugMarkerMarkerInfoEXT pMarkerName(@NativeType("const char *") ByteBuffer value) { npMarkerName(address(), value); return this; }
/** Copies the specified {@link FloatBuffer} to the {@code color} field. */
public VkDebugMarkerMarkerInfoEXT color(@NativeType("float[4]") FloatBuffer value) { ncolor(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code color} field. */
public VkDebugMarkerMarkerInfoEXT color(int index, float value) { ncolor(address(), index, value); return this; }
/** Initializes this struct with the specified values. */
public VkDebugMarkerMarkerInfoEXT set(
int sType,
long pNext,
ByteBuffer pMarkerName,
FloatBuffer color
) {
sType(sType);
pNext(pNext);
pMarkerName(pMarkerName);
color(color);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkDebugMarkerMarkerInfoEXT set(VkDebugMarkerMarkerInfoEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDebugMarkerMarkerInfoEXT malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDebugMarkerMarkerInfoEXT calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated with {@link BufferUtils}. */
public static VkDebugMarkerMarkerInfoEXT create() {
return new VkDebugMarkerMarkerInfoEXT(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance for the specified memory address. */
public static VkDebugMarkerMarkerInfoEXT create(long address) {
return new VkDebugMarkerMarkerInfoEXT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDebugMarkerMarkerInfoEXT createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDebugMarkerMarkerInfoEXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated on the thread-local {@link MemoryStack}. */
public static VkDebugMarkerMarkerInfoEXT mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkDebugMarkerMarkerInfoEXT callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDebugMarkerMarkerInfoEXT mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDebugMarkerMarkerInfoEXT callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkDebugMarkerMarkerInfoEXT.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkDebugMarkerMarkerInfoEXT.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 VkDebugMarkerMarkerInfoEXT.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkDebugMarkerMarkerInfoEXT.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkDebugMarkerMarkerInfoEXT.PNEXT); }
/** Unsafe version of {@link #pMarkerName}. */
public static ByteBuffer npMarkerName(long struct) { return memByteBufferNT1(memGetAddress(struct + VkDebugMarkerMarkerInfoEXT.PMARKERNAME)); }
/** Unsafe version of {@link #pMarkerNameString}. */
public static String npMarkerNameString(long struct) { return memUTF8(memGetAddress(struct + VkDebugMarkerMarkerInfoEXT.PMARKERNAME)); }
/** Unsafe version of {@link #color}. */
public static FloatBuffer ncolor(long struct) { return memFloatBuffer(struct + VkDebugMarkerMarkerInfoEXT.COLOR, 4); }
/** Unsafe version of {@link #color(int) color}. */
public static float ncolor(long struct, int index) {
if (CHECKS) { check(index, 4); }
return memGetFloat(struct + VkDebugMarkerMarkerInfoEXT.COLOR + index * 4);
}
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkDebugMarkerMarkerInfoEXT.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkDebugMarkerMarkerInfoEXT.PNEXT, value); }
/** Unsafe version of {@link #pMarkerName(ByteBuffer) pMarkerName}. */
public static void npMarkerName(long struct, ByteBuffer value) {
if (CHECKS) { checkNT1(value); }
memPutAddress(struct + VkDebugMarkerMarkerInfoEXT.PMARKERNAME, memAddress(value));
}
/** Unsafe version of {@link #color(FloatBuffer) color}. */
public static void ncolor(long struct, FloatBuffer value) {
if (CHECKS) { checkGT(value, 4); }
memCopy(memAddress(value), struct + VkDebugMarkerMarkerInfoEXT.COLOR, value.remaining() * 4);
}
/** Unsafe version of {@link #color(int, float) color}. */
public static void ncolor(long struct, int index, float value) {
if (CHECKS) { check(index, 4); }
memPutFloat(struct + VkDebugMarkerMarkerInfoEXT.COLOR + index * 4, value);
}
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + VkDebugMarkerMarkerInfoEXT.PMARKERNAME));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkDebugMarkerMarkerInfoEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkDebugMarkerMarkerInfoEXT.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 VkDebugMarkerMarkerInfoEXT#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkDebugMarkerMarkerInfoEXT newInstance(long address) {
return new VkDebugMarkerMarkerInfoEXT(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkDebugMarkerMarkerInfoEXT.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkDebugMarkerMarkerInfoEXT.npNext(address()); }
/** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code pMarkerName} field. */
@NativeType("const char *")
public ByteBuffer pMarkerName() { return VkDebugMarkerMarkerInfoEXT.npMarkerName(address()); }
/** Decodes the null-terminated string pointed to by the {@code pMarkerName} field. */
@NativeType("const char *")
public String pMarkerNameString() { return VkDebugMarkerMarkerInfoEXT.npMarkerNameString(address()); }
/** Returns a {@link FloatBuffer} view of the {@code color} field. */
@NativeType("float[4]")
public FloatBuffer color() { return VkDebugMarkerMarkerInfoEXT.ncolor(address()); }
/** Returns the value at the specified index of the {@code color} field. */
public float color(int index) { return VkDebugMarkerMarkerInfoEXT.ncolor(address(), index); }
/** Sets the specified value to the {@code sType} field. */
public VkDebugMarkerMarkerInfoEXT.Buffer sType(@NativeType("VkStructureType") int value) { VkDebugMarkerMarkerInfoEXT.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkDebugMarkerMarkerInfoEXT.Buffer pNext(@NativeType("const void *") long value) { VkDebugMarkerMarkerInfoEXT.npNext(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code pMarkerName} field. */
public VkDebugMarkerMarkerInfoEXT.Buffer pMarkerName(@NativeType("const char *") ByteBuffer value) { VkDebugMarkerMarkerInfoEXT.npMarkerName(address(), value); return this; }
/** Copies the specified {@link FloatBuffer} to the {@code color} field. */
public VkDebugMarkerMarkerInfoEXT.Buffer color(@NativeType("float[4]") FloatBuffer value) { VkDebugMarkerMarkerInfoEXT.ncolor(address(), value); return this; }
/** Sets the specified value at the specified index of the {@code color} field. */
public VkDebugMarkerMarkerInfoEXT.Buffer color(int index, float value) { VkDebugMarkerMarkerInfoEXT.ncolor(address(), index, value); return this; }
}
}