mirror of
https://github.com/libretro/libretro-3dengine.git
synced 2026-11-07 11:06:04 -10:00
Update libretro.h for the unified VR view API
The header from RetroArch's unified OpenXR pull request (libretro/RetroArch#19811). REQUEST_FLAT and ipd_hint_m are gone from retro_video_views: a flat map is one without TRACKED, and OpenXR always gives real eye poses. Co-authored-by: Craig <[email protected]>
This commit is contained in:
daveyandCraig committed
1 parent
c37957d555
commit
6bfc332eba
2 files changed
+123
-31
No files matched your search
@@ -722,9 +722,10 @@ enum retro_mod
|
||||
*/
|
||||
|
||||
/**
|
||||
* This bit indicates that the associated environment call is experimental,
|
||||
* and may be changed or removed in the future.
|
||||
* Frontends should mask out this bit before handling the environment call.
|
||||
* This bit used to indicate that the associated environment call is experimental,
|
||||
* and may be changed or removed in the future, but this has since changed.
|
||||
* Frontends should NOT mask out this bit before handling the environment call,
|
||||
* as some callbacks need it to distinguish themselves from others.
|
||||
*/
|
||||
#define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
|
||||
|
||||
@@ -1683,6 +1684,22 @@ enum retro_mod
|
||||
*/
|
||||
#define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL)
|
||||
|
||||
/**
|
||||
* Notifies the frontend of any quirks associated with serialization.
|
||||
*
|
||||
* Should be set in either \c retro_init or \c retro_load_game, but not both.
|
||||
* @param[in, out] data <tt>uint64_t *</tt>.
|
||||
* Pointer to the core's serialization quirks.
|
||||
* The frontend will set the flags of the quirks it supports
|
||||
* and clear the flags of those it doesn't.
|
||||
* Behavior is undefined if \c NULL.
|
||||
* @return \c true if this environment call is supported.
|
||||
* @see retro_serialize
|
||||
* @see retro_unserialize
|
||||
* @see RETRO_SERIALIZATION_QUIRK
|
||||
*/
|
||||
#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44
|
||||
|
||||
/**
|
||||
* The frontend will try to use a "shared" context when setting up a hardware context.
|
||||
* Mostly applicable to OpenGL.
|
||||
@@ -2718,20 +2735,12 @@ enum retro_mod
|
||||
#define RETRO_ENVIRONMENT_GET_MEMORY_STATUS (86 | RETRO_ENVIRONMENT_EXPERIMENTAL)
|
||||
|
||||
/**
|
||||
* Notifies the frontend of any quirks associated with serialization.
|
||||
* Legacy compatibility shim to RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS.
|
||||
* Cores should avoid using this, as it is not as well-supported.
|
||||
*
|
||||
* Should be set in either \c retro_init or \c retro_load_game, but not both.
|
||||
* @param[in, out] data <tt>uint64_t *</tt>.
|
||||
* Pointer to the core's serialization quirks.
|
||||
* The frontend will set the flags of the quirks it supports
|
||||
* and clear the flags of those it doesn't.
|
||||
* Behavior is undefined if \c NULL.
|
||||
* @return \c true if this environment call is supported.
|
||||
* @see retro_serialize
|
||||
* @see retro_unserialize
|
||||
* @see RETRO_SERIALIZATION_QUIRK
|
||||
*/
|
||||
#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 87
|
||||
#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS_2 87
|
||||
|
||||
/**
|
||||
* Queries whether the active video driver can present a 10-bit-per-channel
|
||||
@@ -3006,7 +3015,12 @@ enum retro_vr_reference_space {
|
||||
* both eyes are shown; only set together with PRESENTS. */
|
||||
#define RETRO_VIDEO_VIEWS_STATUS_PRESENTS (1 << 0)
|
||||
#define RETRO_VIDEO_VIEWS_STATUS_STEREO (1 << 1)
|
||||
/** An active headset session is presenting; eye-tagged views render on it. */
|
||||
/** A headset session is running and head tracking is available:
|
||||
* RETRO_ENVIRONMENT_GET_VR_FRAME_STATE and GET_VR_HEAD_POSE answer, and a
|
||||
* map with RETRO_VIDEO_VIEWS_FLAG_TRACKED becomes the head-tracked view.
|
||||
* Only set together with PRESENTS and STEREO. A core learns about a
|
||||
* headset from this bit only: SET_VIDEO_VIEWS returning true means the
|
||||
* map was accepted, headset or not. */
|
||||
#define RETRO_VIDEO_VIEWS_STATUS_HMD (1 << 2)
|
||||
|
||||
/* The eye a view shows; see RETRO_ENVIRONMENT_SET_VIDEO_VIEWS. */
|
||||
@@ -3016,8 +3030,14 @@ enum retro_vr_reference_space {
|
||||
|
||||
/* The most views one map may hold. */
|
||||
#define RETRO_VIDEO_VIEWS_MAX 8
|
||||
/** The core asks for a flat presentation even on a headset. */
|
||||
#define RETRO_VIDEO_VIEWS_FLAG_REQUEST_FLAT (1 << 0)
|
||||
/** The map's one LEFT and one RIGHT view were drawn from this frame's
|
||||
* RETRO_ENVIRONMENT_GET_VR_FRAME_STATE eye poses and fields of view.
|
||||
* While RETRO_VIDEO_VIEWS_STATUS_HMD is set, the frontend shows those two
|
||||
* as the headset's head-tracked view and every other view as a screen.
|
||||
* Without HMD the flag changes nothing. While HMD is set, a map with the
|
||||
* flag and any views must hold exactly one LEFT and one RIGHT view, or it
|
||||
* is refused; an empty map clears the views whatever its flags. */
|
||||
#define RETRO_VIDEO_VIEWS_FLAG_TRACKED (1 << 0)
|
||||
|
||||
/**
|
||||
* One view of the frame.
|
||||
@@ -3049,26 +3069,29 @@ struct retro_video_views
|
||||
/** RETRO_VIDEO_VIEWS_FLAG_ values. */
|
||||
unsigned flags;
|
||||
|
||||
/** Headset reference space for eye-tagged views. */
|
||||
/**
|
||||
* The space a TRACKED map's poses are in: LOCAL (seated) or STAGE
|
||||
* (standing, LOCAL where the runtime has none).
|
||||
*/
|
||||
enum retro_vr_reference_space reference_space;
|
||||
|
||||
/**
|
||||
* Requested interpupillary distance in meters, used only if the
|
||||
* frontend cannot obtain one from the runtime/HMD itself.
|
||||
* 0.0f means "use whatever the frontend/runtime already knows".
|
||||
*/
|
||||
float ipd_hint_m;
|
||||
|
||||
/**
|
||||
* Output: recommended size of one eye-tagged view's render target.
|
||||
* The core must not use these to determine its system AV geometry;
|
||||
* the frame geometry stays retro_get_system_av_info()'s.
|
||||
* Output, while RETRO_VIDEO_VIEWS_STATUS_HMD is set: the recommended
|
||||
* size of one eye's render target; 0 otherwise.
|
||||
* The frontend does not change the core's geometry for it: a core
|
||||
* that draws at this size reports its new frame size with
|
||||
* RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO.
|
||||
*/
|
||||
unsigned recommended_view_width;
|
||||
unsigned recommended_view_height;
|
||||
};
|
||||
|
||||
#define RETRO_VR_FRAME_RECENTERED (1u << 0) /* user recentered: re-capture any reference */
|
||||
/* RETRO_VR_FRAME_RECENTERED: the user or the runtime recentered, the
|
||||
* runtime moved STAGE, or a new headset session started, as after a
|
||||
* video driver restart. LOCAL poses then have a new origin; STAGE poses
|
||||
* keep the room's through a recenter. A core that was paused hears of it
|
||||
* at its next frame. A core keeping a reference pose takes it again. */
|
||||
#define RETRO_VR_FRAME_RECENTERED (1u << 0)
|
||||
#define RETRO_VR_FRAME_TARGET_RESIZED (1u << 1) /* eye size changed: call SET_VIDEO_VIEWS again */
|
||||
|
||||
/**
|
||||
@@ -5636,6 +5659,19 @@ enum retro_camera_buffer
|
||||
*/
|
||||
RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER,
|
||||
|
||||
/**
|
||||
* Indicates that camera frames should be delivered to the core as
|
||||
* the planar 4:2:0 YCbCr the capture device produces, in place.
|
||||
*
|
||||
* No conversion happens between the device and the core: the planes
|
||||
* are the capture buffer itself. A core that can sample or convert
|
||||
* YCbCr should prefer this over \c RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER,
|
||||
* which costs the frontend a conversion pass per frame.
|
||||
*
|
||||
* @see retro_camera_frame_planar_t
|
||||
*/
|
||||
RETRO_CAMERA_BUFFER_PLANAR,
|
||||
|
||||
/**
|
||||
* @private Defined to ensure <tt>sizeof(enum retro_camera_buffer) == sizeof(int)</tt>.
|
||||
* Do not use.
|
||||
@@ -5643,6 +5679,44 @@ enum retro_camera_buffer
|
||||
RETRO_CAMERA_BUFFER_DUMMY = INT_MAX
|
||||
};
|
||||
|
||||
/** The luma plane is full range (0..255) rather than limited (16..235). */
|
||||
#define RETRO_CAMERA_PLANAR_FULL_RANGE (1 << 0)
|
||||
/** BT.709 matrix rather than BT.601. */
|
||||
#define RETRO_CAMERA_PLANAR_BT709 (1 << 1)
|
||||
|
||||
/**
|
||||
* One 8-bit 4:2:0 YCbCr frame, as planes.
|
||||
*
|
||||
* Covers NV12, NV21 and I420 without a format tag: the chroma planes
|
||||
* are addressed by their own base pointers and a common sample step,
|
||||
* so NV12 is <tt>planes[2] == planes[1] + 1</tt> with \c chroma_step 2,
|
||||
* NV21 the other way round, and I420 two separate planes with
|
||||
* \c chroma_step 1. Row pairs share a chroma row.
|
||||
*
|
||||
* @see RETRO_CAMERA_BUFFER_PLANAR
|
||||
*/
|
||||
struct retro_camera_planar_frame
|
||||
{
|
||||
/** Y, Cb, Cr. Owned by the frontend, read-only, valid for the duration of the callback. */
|
||||
const uint8_t *planes[3];
|
||||
|
||||
/** Row strides of the three planes, in bytes. */
|
||||
size_t strides[3];
|
||||
|
||||
/** Distance between horizontally adjacent chroma samples of one plane, in bytes: 1 or 2. */
|
||||
size_t chroma_step;
|
||||
|
||||
/** Frame size in luma pixels. */
|
||||
unsigned width;
|
||||
unsigned height;
|
||||
|
||||
/** Degrees the frame must be rotated clockwise to be upright: 0, 90, 180 or 270. */
|
||||
unsigned rotation;
|
||||
|
||||
/** \c RETRO_CAMERA_PLANAR_* bits. */
|
||||
unsigned flags;
|
||||
};
|
||||
|
||||
/**
|
||||
* Starts an initialized camera.
|
||||
* The camera is disabled by default,
|
||||
@@ -5721,6 +5795,17 @@ typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32
|
||||
typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id,
|
||||
unsigned texture_target, const float *affine);
|
||||
|
||||
/**
|
||||
* Called by the frontend to report a new camera frame,
|
||||
* delivered as the capture device's own planar YCbCr buffer.
|
||||
*
|
||||
* @param frame The frame. Its planes may be invalidated when this function returns,
|
||||
* so the core should make its own copy if necessary.
|
||||
* @see RETRO_CAMERA_BUFFER_PLANAR
|
||||
*/
|
||||
typedef void (RETRO_CALLCONV *retro_camera_frame_planar_t)(
|
||||
const struct retro_camera_planar_frame *frame);
|
||||
|
||||
/**
|
||||
* An interface that the core can use to access a device's camera.
|
||||
*
|
||||
@@ -5796,6 +5881,15 @@ struct retro_camera_callback
|
||||
* May be \c NULL, in which case this function is skipped.
|
||||
*/
|
||||
retro_camera_lifetime_status_t deinitialized;
|
||||
|
||||
/**
|
||||
* @copydoc retro_camera_frame_planar_t
|
||||
* @note Read by the frontend only when \c caps has the
|
||||
* \c RETRO_CAMERA_BUFFER_PLANAR bit, so a core built against an
|
||||
* older header, whose struct ends above, is never read past.
|
||||
* If \c NULL, this function will not be called.
|
||||
*/
|
||||
retro_camera_frame_planar_t frame_planar;
|
||||
};
|
||||
|
||||
/** @} */
|
||||
|
||||
@@ -454,9 +454,7 @@ static bool vr_request_session(void)
|
||||
v[1].eye = RETRO_VIDEO_VIEW_EYE_RIGHT;
|
||||
views.views = v;
|
||||
views.num_views = 2;
|
||||
views.flags = vr_user_enable ? 0 : RETRO_VIDEO_VIEWS_FLAG_REQUEST_FLAT;
|
||||
views.reference_space = RETRO_VR_REFERENCE_SPACE_LOCAL; /* eye height == player_pos.y */
|
||||
views.ipd_hint_m = 0.0f;
|
||||
|
||||
if (!environ_cb(RETRO_ENVIRONMENT_SET_VIDEO_VIEWS, &views))
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user