Package org.lwjgl.openxr
Class XrHapticActionInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrHapticActionInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrHapticActionInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceInformation to output haptic feedback.Description
See
XrActionCreateInfofor a description of subaction paths, and the restrictions on their use.Valid Usage (Implicit)
typemust beTYPE_HAPTIC_ACTION_INFOnextmust beNULLor a valid pointer to the next structure in a structure chainactionmust be a validXrActionhandle
See Also
ApplyHapticFeedback,StopHapticFeedbackLayout
struct XrHapticActionInfo { XrStructureTypetype(); void const *next(); XrActionaction(); XrPathsubactionPath(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrHapticActionInfo.BufferAn array ofXrHapticActionInfostructs.
-
Constructor Summary
Constructors Constructor Description XrHapticActionInfo(java.nio.ByteBuffer container)Creates aXrHapticActionInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description longaction()theXrActionhandle for the desired output haptic action.XrHapticActionInfoaction(XrAction value)Sets the specified value to theaction()field.static XrHapticActionInfocalloc()Returns a newXrHapticActionInfoinstance allocated withmemCalloc.static XrHapticActionInfo.Buffercalloc(int capacity)Returns a newXrHapticActionInfo.Bufferinstance allocated withmemCalloc.static XrHapticActionInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHapticActionInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHapticActionInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHapticActionInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHapticActionInfocreate()Returns a newXrHapticActionInfoinstance allocated withBufferUtils.static XrHapticActionInfo.Buffercreate(int capacity)Returns a newXrHapticActionInfo.Bufferinstance allocated withBufferUtils.static XrHapticActionInfocreate(long address)Returns a newXrHapticActionInfoinstance for the specified memory address.static XrHapticActionInfo.Buffercreate(long address, int capacity)Create aXrHapticActionInfo.Bufferinstance at the specified memory.static XrHapticActionInfocreateSafe(long address)static XrHapticActionInfo.BuffercreateSafe(long address, int capacity)static XrHapticActionInfomalloc()Returns a newXrHapticActionInfoinstance allocated withmemAlloc.static XrHapticActionInfo.Buffermalloc(int capacity)Returns a newXrHapticActionInfo.Bufferinstance allocated withmemAlloc.static XrHapticActionInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHapticActionInfo.Bufferinstance allocated on the specifiedMemoryStack.static XrHapticActionInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHapticActionInfoinstance allocated on the specifiedMemoryStack.static longnaction(long struct)Unsafe version ofaction().static voidnaction(long struct, XrAction value)Unsafe version ofaction.longnext()NULLor a pointer to the next structure in a structure chain.XrHapticActionInfonext(long value)Sets the specified value to thenext()field.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static longnsubactionPath(long struct)Unsafe version ofsubactionPath().static voidnsubactionPath(long struct, long value)Unsafe version ofsubactionPath.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrHapticActionInfoset(int type, long next, XrAction action, long subactionPath)Initializes this struct with the specified values.XrHapticActionInfoset(XrHapticActionInfo src)Copies the specified struct data to this struct.intsizeof()longsubactionPath()the subaction pathXrPathof the device to send the haptic event to, orNULL_PATHto specify all subaction paths.XrHapticActionInfosubactionPath(long value)Sets the specified value to thesubactionPath()field.inttype()theXrStructureTypeof this structure.XrHapticActionInfotype(int value)Sets the specified value to thetype()field.XrHapticActionInfotype$Default()Sets theTYPE_HAPTIC_ACTION_INFOvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrHapticActionInfo
public XrHapticActionInfo(java.nio.ByteBuffer container)
Creates aXrHapticActionInfoinstance at the current position of the specifiedByteBuffercontainer. 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.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
action
public long action()
theXrActionhandle for the desired output haptic action.
-
subactionPath
public long subactionPath()
the subaction pathXrPathof the device to send the haptic event to, orNULL_PATHto specify all subaction paths. If the subaction path is specified, it is one of the subaction paths that were specified when the action was created. If the subaction path was not specified when the action was created, the runtime must returnERROR_PATH_UNSUPPORTED. If this parameter is specified, the runtime must trigger the haptic events only on the device from the subaction path.
-
type
public XrHapticActionInfo type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrHapticActionInfo type$Default()
Sets theTYPE_HAPTIC_ACTION_INFOvalue to thetype()field.
-
next
public XrHapticActionInfo next(long value)
Sets the specified value to thenext()field.
-
action
public XrHapticActionInfo action(XrAction value)
Sets the specified value to theaction()field.
-
subactionPath
public XrHapticActionInfo subactionPath(long value)
Sets the specified value to thesubactionPath()field.
-
set
public XrHapticActionInfo set(int type, long next, XrAction action, long subactionPath)
Initializes this struct with the specified values.
-
set
public XrHapticActionInfo set(XrHapticActionInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrHapticActionInfo malloc()
Returns a newXrHapticActionInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrHapticActionInfo calloc()
Returns a newXrHapticActionInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrHapticActionInfo create()
Returns a newXrHapticActionInfoinstance allocated withBufferUtils.
-
create
public static XrHapticActionInfo create(long address)
Returns a newXrHapticActionInfoinstance for the specified memory address.
-
createSafe
@Nullable public static XrHapticActionInfo createSafe(long address)
-
malloc
public static XrHapticActionInfo.Buffer malloc(int capacity)
Returns a newXrHapticActionInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrHapticActionInfo.Buffer calloc(int capacity)
Returns a newXrHapticActionInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrHapticActionInfo.Buffer create(int capacity)
Returns a newXrHapticActionInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrHapticActionInfo.Buffer create(long address, int capacity)
Create aXrHapticActionInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrHapticActionInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static XrHapticActionInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticActionInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrHapticActionInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticActionInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrHapticActionInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticActionInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrHapticActionInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticActionInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
naction
public static long naction(long struct)
Unsafe version ofaction().
-
nsubactionPath
public static long nsubactionPath(long struct)
Unsafe version ofsubactionPath().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nsubactionPath
public static void nsubactionPath(long struct, long value)Unsafe version ofsubactionPath.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-