org.lwjgl.openxr.XrHapticVibration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-openxr Show documentation
Show all versions of lwjgl-openxr Show documentation
A royalty-free, open standard that provides high-performance access to Augmented Reality (AR) and Virtual Reality (VR)—collectively known as XR—platforms and devices.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.openxr;
import org.jspecify.annotations.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Base header for haptic feedback.
*
* Description
*
* The {@link XrHapticVibration} is used in calls to {@link XR10#xrApplyHapticFeedback ApplyHapticFeedback} that trigger actionname:vibration output actions.
*
* The {@code duration}, and {@code frequency} parameters may be clamped to implementation-dependent ranges.
*
* Valid Usage (Implicit)
*
*
* - {@code type} must be {@link XR10#XR_TYPE_HAPTIC_VIBRATION TYPE_HAPTIC_VIBRATION}
* - {@code next} must be {@code NULL} or a valid pointer to the next structure in a structure chain
*
*
* See Also
*
* {@link XrHapticBaseHeader}, {@link XR10#xrApplyHapticFeedback ApplyHapticFeedback}
*
* Layout
*
*
* struct XrHapticVibration {
* XrStructureType {@link #type};
* void const * {@link #next};
* XrDuration {@link #duration};
* float {@link #frequency};
* float {@link #amplitude};
* }
*/
public class XrHapticVibration 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
TYPE,
NEXT,
DURATION,
FREQUENCY,
AMPLITUDE;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(8),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
TYPE = layout.offsetof(0);
NEXT = layout.offsetof(1);
DURATION = layout.offsetof(2);
FREQUENCY = layout.offsetof(3);
AMPLITUDE = layout.offsetof(4);
}
protected XrHapticVibration(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected XrHapticVibration create(long address, @Nullable ByteBuffer container) {
return new XrHapticVibration(address, container);
}
/**
* Creates a {@code XrHapticVibration} 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 XrHapticVibration(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the {@code XrStructureType} of this structure. */
@NativeType("XrStructureType")
public int type() { return ntype(address()); }
/** {@code NULL} or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR. */
@NativeType("void const *")
public long next() { return nnext(address()); }
/** the number of nanoseconds the vibration should last. If {@link XR10#XR_MIN_HAPTIC_DURATION MIN_HAPTIC_DURATION} is specified, the runtime must produce a short haptics pulse of minimal supported duration for the haptic device. */
@NativeType("XrDuration")
public long duration() { return nduration(address()); }
/** the frequency of the vibration in Hz. If {@link XR10#XR_FREQUENCY_UNSPECIFIED FREQUENCY_UNSPECIFIED} is specified, it is left to the runtime to decide the optimal frequency value to use. */
public float frequency() { return nfrequency(address()); }
/** the amplitude of the vibration between 0.0 and 1.0. */
public float amplitude() { return namplitude(address()); }
/** Sets the specified value to the {@link #type} field. */
public XrHapticVibration type(@NativeType("XrStructureType") int value) { ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_HAPTIC_VIBRATION TYPE_HAPTIC_VIBRATION} value to the {@link #type} field. */
public XrHapticVibration type$Default() { return type(XR10.XR_TYPE_HAPTIC_VIBRATION); }
/** Sets the specified value to the {@link #next} field. */
public XrHapticVibration next(@NativeType("void const *") long value) { nnext(address(), value); return this; }
/** Sets the specified value to the {@link #duration} field. */
public XrHapticVibration duration(@NativeType("XrDuration") long value) { nduration(address(), value); return this; }
/** Sets the specified value to the {@link #frequency} field. */
public XrHapticVibration frequency(float value) { nfrequency(address(), value); return this; }
/** Sets the specified value to the {@link #amplitude} field. */
public XrHapticVibration amplitude(float value) { namplitude(address(), value); return this; }
/** Initializes this struct with the specified values. */
public XrHapticVibration set(
int type,
long next,
long duration,
float frequency,
float amplitude
) {
type(type);
next(next);
duration(duration);
frequency(frequency);
amplitude(amplitude);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public XrHapticVibration set(XrHapticVibration src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code XrHapticVibration} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static XrHapticVibration malloc() {
return new XrHapticVibration(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code XrHapticVibration} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static XrHapticVibration calloc() {
return new XrHapticVibration(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code XrHapticVibration} instance allocated with {@link BufferUtils}. */
public static XrHapticVibration create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new XrHapticVibration(memAddress(container), container);
}
/** Returns a new {@code XrHapticVibration} instance for the specified memory address. */
public static XrHapticVibration create(long address) {
return new XrHapticVibration(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
public static @Nullable XrHapticVibration createSafe(long address) {
return address == NULL ? null : new XrHapticVibration(address, null);
}
/** Downcasts the specified {@code XrHapticBaseHeader} instance to {@code XrHapticVibration}. */
public static XrHapticVibration create(XrHapticBaseHeader value) {
return new XrHapticVibration(value.address(), __getContainer(value));
}
/**
* Returns a new {@link XrHapticVibration.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHapticVibration.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link XrHapticVibration.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static XrHapticVibration.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link XrHapticVibration.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static XrHapticVibration.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link XrHapticVibration.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static XrHapticVibration.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}. */
public static XrHapticVibration.@Nullable Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/** Downcasts the specified {@code XrHapticBaseHeader.Buffer} instance to {@code XrHapticVibration.Buffer}. */
public static XrHapticVibration.Buffer create(XrHapticBaseHeader.Buffer value) {
return new XrHapticVibration.Buffer(value.address(), __getContainer(value), -1, 0, value.remaining(), value.remaining());
}
/**
* Returns a new {@code XrHapticVibration} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static XrHapticVibration malloc(MemoryStack stack) {
return new XrHapticVibration(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code XrHapticVibration} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static XrHapticVibration calloc(MemoryStack stack) {
return new XrHapticVibration(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link XrHapticVibration.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static XrHapticVibration.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link XrHapticVibration.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 XrHapticVibration.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #type}. */
public static int ntype(long struct) { return memGetInt(struct + XrHapticVibration.TYPE); }
/** Unsafe version of {@link #next}. */
public static long nnext(long struct) { return memGetAddress(struct + XrHapticVibration.NEXT); }
/** Unsafe version of {@link #duration}. */
public static long nduration(long struct) { return memGetLong(struct + XrHapticVibration.DURATION); }
/** Unsafe version of {@link #frequency}. */
public static float nfrequency(long struct) { return memGetFloat(struct + XrHapticVibration.FREQUENCY); }
/** Unsafe version of {@link #amplitude}. */
public static float namplitude(long struct) { return memGetFloat(struct + XrHapticVibration.AMPLITUDE); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + XrHapticVibration.TYPE, value); }
/** Unsafe version of {@link #next(long) next}. */
public static void nnext(long struct, long value) { memPutAddress(struct + XrHapticVibration.NEXT, value); }
/** Unsafe version of {@link #duration(long) duration}. */
public static void nduration(long struct, long value) { memPutLong(struct + XrHapticVibration.DURATION, value); }
/** Unsafe version of {@link #frequency(float) frequency}. */
public static void nfrequency(long struct, float value) { memPutFloat(struct + XrHapticVibration.FREQUENCY, value); }
/** Unsafe version of {@link #amplitude(float) amplitude}. */
public static void namplitude(long struct, float value) { memPutFloat(struct + XrHapticVibration.AMPLITUDE, value); }
// -----------------------------------
/** An array of {@link XrHapticVibration} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final XrHapticVibration ELEMENT_FACTORY = XrHapticVibration.create(-1L);
/**
* Creates a new {@code XrHapticVibration.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 XrHapticVibration#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 create(long address, @Nullable ByteBuffer container, int mark, int position, int limit, int capacity) {
return new Buffer(address, container, mark, position, limit, capacity);
}
@Override
protected XrHapticVibration getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link XrHapticVibration#type} field. */
@NativeType("XrStructureType")
public int type() { return XrHapticVibration.ntype(address()); }
/** @return the value of the {@link XrHapticVibration#next} field. */
@NativeType("void const *")
public long next() { return XrHapticVibration.nnext(address()); }
/** @return the value of the {@link XrHapticVibration#duration} field. */
@NativeType("XrDuration")
public long duration() { return XrHapticVibration.nduration(address()); }
/** @return the value of the {@link XrHapticVibration#frequency} field. */
public float frequency() { return XrHapticVibration.nfrequency(address()); }
/** @return the value of the {@link XrHapticVibration#amplitude} field. */
public float amplitude() { return XrHapticVibration.namplitude(address()); }
/** Sets the specified value to the {@link XrHapticVibration#type} field. */
public XrHapticVibration.Buffer type(@NativeType("XrStructureType") int value) { XrHapticVibration.ntype(address(), value); return this; }
/** Sets the {@link XR10#XR_TYPE_HAPTIC_VIBRATION TYPE_HAPTIC_VIBRATION} value to the {@link XrHapticVibration#type} field. */
public XrHapticVibration.Buffer type$Default() { return type(XR10.XR_TYPE_HAPTIC_VIBRATION); }
/** Sets the specified value to the {@link XrHapticVibration#next} field. */
public XrHapticVibration.Buffer next(@NativeType("void const *") long value) { XrHapticVibration.nnext(address(), value); return this; }
/** Sets the specified value to the {@link XrHapticVibration#duration} field. */
public XrHapticVibration.Buffer duration(@NativeType("XrDuration") long value) { XrHapticVibration.nduration(address(), value); return this; }
/** Sets the specified value to the {@link XrHapticVibration#frequency} field. */
public XrHapticVibration.Buffer frequency(float value) { XrHapticVibration.nfrequency(address(), value); return this; }
/** Sets the specified value to the {@link XrHapticVibration#amplitude} field. */
public XrHapticVibration.Buffer amplitude(float value) { XrHapticVibration.namplitude(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy