org.lwjgl.vulkan.VkVideoEncodeH264SessionCreateInfoEXT 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.*;
/**
* Structure specifies H.264 encoder creation parameters.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link EXTVideoEncodeH264#VK_STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT}
* - {@code flags} must be a valid combination of {@code VkVideoEncodeH264CreateFlagBitsEXT} values
* - {@code flags} must not be 0
* - {@code pStdExtensionVersion} must be a valid pointer to a valid {@link VkExtensionProperties} structure
*
*
* See Also
*
* {@link VkExtensionProperties}, {@link VkExtent2D}
*
* Layout
*
*
* struct VkVideoEncodeH264SessionCreateInfoEXT {
* VkStructureType {@link #sType};
* void const * {@link #pNext};
* VkVideoEncodeH264CreateFlagsEXT {@link #flags};
* {@link VkExtent2D VkExtent2D} {@link #maxPictureSizeInMbs};
* {@link VkExtensionProperties VkExtensionProperties} const * {@link #pStdExtensionVersion};
* }
*/
public class VkVideoEncodeH264SessionCreateInfoEXT 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,
FLAGS,
MAXPICTURESIZEINMBS,
PSTDEXTENSIONVERSION;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(VkExtent2D.SIZEOF, VkExtent2D.ALIGNOF),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
FLAGS = layout.offsetof(2);
MAXPICTURESIZEINMBS = layout.offsetof(3);
PSTDEXTENSIONVERSION = layout.offsetof(4);
}
/**
* Creates a {@code VkVideoEncodeH264SessionCreateInfoEXT} 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 VkVideoEncodeH264SessionCreateInfoEXT(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the type of this structure. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** {@code NULL} or a pointer to a structure extending this structure. */
@NativeType("void const *")
public long pNext() { return npNext(address()); }
/** a bitmask of {@code VkVideoEncodeH264CreateFlagsEXT} specifying H.264 encoder creation flags. */
@NativeType("VkVideoEncodeH264CreateFlagsEXT")
public int flags() { return nflags(address()); }
/** specifies the syntax element pic_width_in_mbs_minus1 + 1 and the syntax element pic_height_in_map_units_minus1 + 1. */
public VkExtent2D maxPictureSizeInMbs() { return nmaxPictureSizeInMbs(address()); }
/** a pointer to a {@link VkExtensionProperties} structure specifying H.264 codec extensions. */
@NativeType("VkExtensionProperties const *")
public VkExtensionProperties pStdExtensionVersion() { return npStdExtensionVersion(address()); }
/** Sets the specified value to the {@link #sType} field. */
public VkVideoEncodeH264SessionCreateInfoEXT sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the {@link EXTVideoEncodeH264#VK_STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT} value to the {@link #sType} field. */
public VkVideoEncodeH264SessionCreateInfoEXT sType$Default() { return sType(EXTVideoEncodeH264.VK_STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT); }
/** Sets the specified value to the {@link #pNext} field. */
public VkVideoEncodeH264SessionCreateInfoEXT pNext(@NativeType("void const *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@link #flags} field. */
public VkVideoEncodeH264SessionCreateInfoEXT flags(@NativeType("VkVideoEncodeH264CreateFlagsEXT") int value) { nflags(address(), value); return this; }
/** Copies the specified {@link VkExtent2D} to the {@link #maxPictureSizeInMbs} field. */
public VkVideoEncodeH264SessionCreateInfoEXT maxPictureSizeInMbs(VkExtent2D value) { nmaxPictureSizeInMbs(address(), value); return this; }
/** Passes the {@link #maxPictureSizeInMbs} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkVideoEncodeH264SessionCreateInfoEXT maxPictureSizeInMbs(java.util.function.Consumer consumer) { consumer.accept(maxPictureSizeInMbs()); return this; }
/** Sets the address of the specified {@link VkExtensionProperties} to the {@link #pStdExtensionVersion} field. */
public VkVideoEncodeH264SessionCreateInfoEXT pStdExtensionVersion(@NativeType("VkExtensionProperties const *") VkExtensionProperties value) { npStdExtensionVersion(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkVideoEncodeH264SessionCreateInfoEXT set(
int sType,
long pNext,
int flags,
VkExtent2D maxPictureSizeInMbs,
VkExtensionProperties pStdExtensionVersion
) {
sType(sType);
pNext(pNext);
flags(flags);
maxPictureSizeInMbs(maxPictureSizeInMbs);
pStdExtensionVersion(pStdExtensionVersion);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkVideoEncodeH264SessionCreateInfoEXT set(VkVideoEncodeH264SessionCreateInfoEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkVideoEncodeH264SessionCreateInfoEXT malloc() {
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkVideoEncodeH264SessionCreateInfoEXT calloc() {
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance allocated with {@link BufferUtils}. */
public static VkVideoEncodeH264SessionCreateInfoEXT create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, memAddress(container), container);
}
/** Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance for the specified memory address. */
public static VkVideoEncodeH264SessionCreateInfoEXT create(long address) {
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkVideoEncodeH264SessionCreateInfoEXT createSafe(long address) {
return address == NULL ? null : wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, address);
}
/**
* Returns a new {@link VkVideoEncodeH264SessionCreateInfoEXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVideoEncodeH264SessionCreateInfoEXT.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkVideoEncodeH264SessionCreateInfoEXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkVideoEncodeH264SessionCreateInfoEXT.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkVideoEncodeH264SessionCreateInfoEXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkVideoEncodeH264SessionCreateInfoEXT.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkVideoEncodeH264SessionCreateInfoEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkVideoEncodeH264SessionCreateInfoEXT.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 VkVideoEncodeH264SessionCreateInfoEXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkVideoEncodeH264SessionCreateInfoEXT malloc(MemoryStack stack) {
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkVideoEncodeH264SessionCreateInfoEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkVideoEncodeH264SessionCreateInfoEXT calloc(MemoryStack stack) {
return wrap(VkVideoEncodeH264SessionCreateInfoEXT.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkVideoEncodeH264SessionCreateInfoEXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkVideoEncodeH264SessionCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkVideoEncodeH264SessionCreateInfoEXT.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 VkVideoEncodeH264SessionCreateInfoEXT.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 + VkVideoEncodeH264SessionCreateInfoEXT.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkVideoEncodeH264SessionCreateInfoEXT.PNEXT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return UNSAFE.getInt(null, struct + VkVideoEncodeH264SessionCreateInfoEXT.FLAGS); }
/** Unsafe version of {@link #maxPictureSizeInMbs}. */
public static VkExtent2D nmaxPictureSizeInMbs(long struct) { return VkExtent2D.create(struct + VkVideoEncodeH264SessionCreateInfoEXT.MAXPICTURESIZEINMBS); }
/** Unsafe version of {@link #pStdExtensionVersion}. */
public static VkExtensionProperties npStdExtensionVersion(long struct) { return VkExtensionProperties.create(memGetAddress(struct + VkVideoEncodeH264SessionCreateInfoEXT.PSTDEXTENSIONVERSION)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { UNSAFE.putInt(null, struct + VkVideoEncodeH264SessionCreateInfoEXT.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkVideoEncodeH264SessionCreateInfoEXT.PNEXT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { UNSAFE.putInt(null, struct + VkVideoEncodeH264SessionCreateInfoEXT.FLAGS, value); }
/** Unsafe version of {@link #maxPictureSizeInMbs(VkExtent2D) maxPictureSizeInMbs}. */
public static void nmaxPictureSizeInMbs(long struct, VkExtent2D value) { memCopy(value.address(), struct + VkVideoEncodeH264SessionCreateInfoEXT.MAXPICTURESIZEINMBS, VkExtent2D.SIZEOF); }
/** Unsafe version of {@link #pStdExtensionVersion(VkExtensionProperties) pStdExtensionVersion}. */
public static void npStdExtensionVersion(long struct, VkExtensionProperties value) { memPutAddress(struct + VkVideoEncodeH264SessionCreateInfoEXT.PSTDEXTENSIONVERSION, value.address()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + VkVideoEncodeH264SessionCreateInfoEXT.PSTDEXTENSIONVERSION));
}
// -----------------------------------
/** An array of {@link VkVideoEncodeH264SessionCreateInfoEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkVideoEncodeH264SessionCreateInfoEXT ELEMENT_FACTORY = VkVideoEncodeH264SessionCreateInfoEXT.create(-1L);
/**
* Creates a new {@code VkVideoEncodeH264SessionCreateInfoEXT.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 VkVideoEncodeH264SessionCreateInfoEXT#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 VkVideoEncodeH264SessionCreateInfoEXT getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkVideoEncodeH264SessionCreateInfoEXT#sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkVideoEncodeH264SessionCreateInfoEXT.nsType(address()); }
/** @return the value of the {@link VkVideoEncodeH264SessionCreateInfoEXT#pNext} field. */
@NativeType("void const *")
public long pNext() { return VkVideoEncodeH264SessionCreateInfoEXT.npNext(address()); }
/** @return the value of the {@link VkVideoEncodeH264SessionCreateInfoEXT#flags} field. */
@NativeType("VkVideoEncodeH264CreateFlagsEXT")
public int flags() { return VkVideoEncodeH264SessionCreateInfoEXT.nflags(address()); }
/** @return a {@link VkExtent2D} view of the {@link VkVideoEncodeH264SessionCreateInfoEXT#maxPictureSizeInMbs} field. */
public VkExtent2D maxPictureSizeInMbs() { return VkVideoEncodeH264SessionCreateInfoEXT.nmaxPictureSizeInMbs(address()); }
/** @return a {@link VkExtensionProperties} view of the struct pointed to by the {@link VkVideoEncodeH264SessionCreateInfoEXT#pStdExtensionVersion} field. */
@NativeType("VkExtensionProperties const *")
public VkExtensionProperties pStdExtensionVersion() { return VkVideoEncodeH264SessionCreateInfoEXT.npStdExtensionVersion(address()); }
/** Sets the specified value to the {@link VkVideoEncodeH264SessionCreateInfoEXT#sType} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer sType(@NativeType("VkStructureType") int value) { VkVideoEncodeH264SessionCreateInfoEXT.nsType(address(), value); return this; }
/** Sets the {@link EXTVideoEncodeH264#VK_STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT} value to the {@link VkVideoEncodeH264SessionCreateInfoEXT#sType} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer sType$Default() { return sType(EXTVideoEncodeH264.VK_STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_CREATE_INFO_EXT); }
/** Sets the specified value to the {@link VkVideoEncodeH264SessionCreateInfoEXT#pNext} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer pNext(@NativeType("void const *") long value) { VkVideoEncodeH264SessionCreateInfoEXT.npNext(address(), value); return this; }
/** Sets the specified value to the {@link VkVideoEncodeH264SessionCreateInfoEXT#flags} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer flags(@NativeType("VkVideoEncodeH264CreateFlagsEXT") int value) { VkVideoEncodeH264SessionCreateInfoEXT.nflags(address(), value); return this; }
/** Copies the specified {@link VkExtent2D} to the {@link VkVideoEncodeH264SessionCreateInfoEXT#maxPictureSizeInMbs} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer maxPictureSizeInMbs(VkExtent2D value) { VkVideoEncodeH264SessionCreateInfoEXT.nmaxPictureSizeInMbs(address(), value); return this; }
/** Passes the {@link VkVideoEncodeH264SessionCreateInfoEXT#maxPictureSizeInMbs} field to the specified {@link java.util.function.Consumer Consumer}. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer maxPictureSizeInMbs(java.util.function.Consumer consumer) { consumer.accept(maxPictureSizeInMbs()); return this; }
/** Sets the address of the specified {@link VkExtensionProperties} to the {@link VkVideoEncodeH264SessionCreateInfoEXT#pStdExtensionVersion} field. */
public VkVideoEncodeH264SessionCreateInfoEXT.Buffer pStdExtensionVersion(@NativeType("VkExtensionProperties const *") VkExtensionProperties value) { VkVideoEncodeH264SessionCreateInfoEXT.npStdExtensionVersion(address(), value); return this; }
}
}