Render Sender

Typedefs Index

typedef	void(* qar_render_sender_begin_frame_callback_t)(QarResult status, QarRenderFrameInfo *frame_info, void *user_state)
typedef	void(* qar_render_sender_change_layout_callback_t)(QarResult status, void *user_state)
typedef	void(* qar_render_sender_create_callback_t)(QarResult status, QarRenderSender *out_stream, void *user_state)

Functions Index

static QarResult	qar_render_frame_info_get_view_fov (QarRenderFrameInfo *handle, size_t view_index, QarFov *out_fov)
static QarResult	qar_render_frame_info_get_view_pose (QarRenderFrameInfo *handle, size_t view_index, QarPose *out_pose)
static void	qar_render_frame_info_handle_destroy (QarRenderFrameInfo *handle)
static bool	qar_render_frame_info_handle_is_valid (QarRenderFrameInfo *handle)
static QarResult	qar_render_request_get_stream_id (QarRenderStreamRequest *request, QarStreamId *out_stream_id)
	Get the stream id from a render request. More...
static QarResult	qar_render_request_get_target_peer_id (QarRenderStreamRequest *request, QarPeerId *out_peer_id)
	Get the target peer id from a render request. More...
static void	qar_render_request_handle_destroy (QarRenderStreamRequest *request)
	Destroy a render stream request handle. More...
static bool	qar_render_request_handle_is_valid (QarRenderStreamRequest *request)
	Check if a render stream request handle is valid. More...
static QarResult	qar_render_sender_begin_frame (QarRenderSender *stream, QarCancelToken *token, QarRenderFrameInfo **out_frame_info)
	Begin producing a new frame. More...
static QarResult	qar_render_sender_begin_frame_async (QarRenderSender *stream, qar_render_sender_begin_frame_callback_t callback, void *user_state, QarCancelToken *token)
	Async version of begin_frame. More...
static QarResult	qar_render_sender_change_layout (QarRenderSender *stream, const QarVideoFrameLayout *layout, QarCancelToken *token)
	Request a layout change for subsequent frames. More...
static QarResult	qar_render_sender_change_layout_async (QarRenderSender *stream, const QarVideoFrameLayout *layout, qar_render_sender_change_layout_callback_t callback, void *user_state, QarCancelToken *token)
	Async version of change_layout. More...
static QarResult	qar_render_sender_create (QarSession *session, QarRenderSenderInit *init, QarCancelToken *cancel, QarRenderSender **out_stream)
	Create a rendering stream sender bound to a session. More...
static QarResult	qar_render_sender_create_async (QarSession *session, QarRenderSenderInit *init, qar_render_sender_create_callback_t callback, void *user_state, QarCancelToken *token)
	Async variant of qar_render_sender_create. More...
static QarResult	qar_render_sender_frame_cpu (QarRenderSender *stream, QarVideoFrameCpu *out_frame)
	Get CPU-backed frame write access. More...
static QarResult	qar_render_sender_frame_d3d11 (QarRenderSender *stream, QarVideoFrameD3D11 *out_frame)
	Get D3D11-backed frame write access. More...
static QarResult	qar_render_sender_last_hands (QarRenderSender *stream, QarDeviceHandsWithJoints *out_hands)
	Query the last tracked hands data associated with the stream. More...
static QarResult	qar_render_sender_layout (QarRenderSender *stream, QarVideoFrameLayout *out_layout)
	Retrieve the current video frame layout. More...
static QarResult	qar_render_sender_show_frame (QarRenderSender *stream, const QarRenderFrameShow *frame_show)
	Submit the rendered frame for presentation/streaming. More...
static QarResult	qar_render_sender_subscribe_requests (QarSession *session, qar_render_sender_request_callback_t callback, void *user_state, QarCancelToken *token)
	Subscribe to pending render stream requests for this session. More...
static void	qar_render_stream_handle_destroy (QarRenderSender *handle)
	Destroy a render stream sender handle. More...

Typedefs

qar_render_sender_begin_frame_callback_t

typedef void(* qar_render_sender_begin_frame_callback_t)(QarResult status, QarRenderFrameInfo *frame_info, void *user_state)

Definition at line 1808 of file qar_streaming.h.

qar_render_sender_change_layout_callback_t

typedef void(* qar_render_sender_change_layout_callback_t)(QarResult status, void *user_state)

Definition at line 1776 of file qar_streaming.h.

qar_render_sender_create_callback_t

typedef void(* qar_render_sender_create_callback_t)(QarResult status, QarRenderSender *out_stream, void *user_state)

Definition at line 1755 of file qar_streaming.h.

Functions

qar_render_frame_info_get_view_fov()

QarResult qar_render_frame_info_get_view_fov (QarRenderFrameInfo * handle, size_t view_index, QarFov * out_fov)

inline static

Definition at line 1838 of file qar_streaming.h.

qar_render_frame_info_get_view_pose()

QarResult qar_render_frame_info_get_view_pose (QarRenderFrameInfo * handle, size_t view_index, QarPose * out_pose)

inline static

Definition at line 1835 of file qar_streaming.h.

qar_render_frame_info_handle_destroy()

void qar_render_frame_info_handle_destroy (QarRenderFrameInfo * handle)

inline static

Definition at line 1834 of file qar_streaming.h.

qar_render_frame_info_handle_is_valid()

bool qar_render_frame_info_handle_is_valid (QarRenderFrameInfo * handle)

inline static

Definition at line 3966 of file qar_streaming.h.

qar_render_request_get_stream_id()

QarResult qar_render_request_get_stream_id (QarRenderStreamRequest * request, QarStreamId * out_stream_id)

inline static

Get the stream id from a render request.

Definition at line 1739 of file qar_streaming.h.

qar_render_request_get_target_peer_id()

QarResult qar_render_request_get_target_peer_id (QarRenderStreamRequest * request, QarPeerId * out_peer_id)

inline static

Get the target peer id from a render request.

Definition at line 1735 of file qar_streaming.h.

qar_render_request_handle_destroy()

void qar_render_request_handle_destroy (QarRenderStreamRequest * request)

inline static

Destroy a render stream request handle.

Definition at line 1733 of file qar_streaming.h.

qar_render_request_handle_is_valid()

bool qar_render_request_handle_is_valid (QarRenderStreamRequest * request)

inline static

Check if a render stream request handle is valid.

Definition at line 3972 of file qar_streaming.h.

qar_render_sender_begin_frame()

QarResult qar_render_sender_begin_frame (QarRenderSender * stream, QarCancelToken * token, QarRenderFrameInfo ** out_frame_info)

inline static

Begin producing a new frame.

Returns per-frame information such as per-eye pose/FOV to render with.

Definition at line 1803 of file qar_streaming.h.

qar_render_sender_begin_frame_async()

QarResult qar_render_sender_begin_frame_async (QarRenderSender * stream, qar_render_sender_begin_frame_callback_t callback, void * user_state, QarCancelToken * token)

inline static

Async version of begin_frame.

Definition at line 1812 of file qar_streaming.h.

qar_render_sender_change_layout()

QarResult qar_render_sender_change_layout (QarRenderSender * stream, const QarVideoFrameLayout * layout, QarCancelToken * token)

inline static

Request a layout change for subsequent frames.

Definition at line 1771 of file qar_streaming.h.

qar_render_sender_change_layout_async()

QarResult qar_render_sender_change_layout_async (QarRenderSender * stream, const QarVideoFrameLayout * layout, qar_render_sender_change_layout_callback_t callback, void * user_state, QarCancelToken * token)

inline static

Async version of change_layout.

Definition at line 1780 of file qar_streaming.h.

qar_render_sender_create()

QarResult qar_render_sender_create (QarSession * session, QarRenderSenderInit * init, QarCancelToken * cancel, QarRenderSender ** out_stream)

inline static

Create a rendering stream sender bound to a session.

Parameters

session	Active session handle.
init	Stream configuration (views, formats, target peer, etc.).
cancel	Optional cancellation token for creation.
out_stream	Receives the created stream sender handle.

Definition at line 1749 of file qar_streaming.h.

qar_render_sender_create_async()

QarResult qar_render_sender_create_async (QarSession * session, QarRenderSenderInit * init, qar_render_sender_create_callback_t callback, void * user_state, QarCancelToken * token)

inline static

Async variant of qar_render_sender_create.

Definition at line 1759 of file qar_streaming.h.

qar_render_sender_frame_cpu()

QarResult qar_render_sender_frame_cpu (QarRenderSender * stream, QarVideoFrameCpu * out_frame)

inline static

Get CPU-backed frame write access.

Definition at line 1788 of file qar_streaming.h.

qar_render_sender_frame_d3d11()

QarResult qar_render_sender_frame_d3d11 (QarRenderSender * stream, QarVideoFrameD3D11 * out_frame)

inline static

Get D3D11-backed frame write access.

Definition at line 1793 of file qar_streaming.h.

qar_render_sender_last_hands()

QarResult qar_render_sender_last_hands (QarRenderSender * stream, QarDeviceHandsWithJoints * out_hands)

inline static

Query the last tracked hands data associated with the stream.

Definition at line 1827 of file qar_streaming.h.

qar_render_sender_layout()

QarResult qar_render_sender_layout (QarRenderSender * stream, QarVideoFrameLayout * out_layout)

inline static

Retrieve the current video frame layout.

Definition at line 1767 of file qar_streaming.h.

qar_render_sender_show_frame()

QarResult qar_render_sender_show_frame (QarRenderSender * stream, const QarRenderFrameShow * frame_show)

inline static

Submit the rendered frame for presentation/streaming.

Definition at line 1821 of file qar_streaming.h.

qar_render_sender_subscribe_requests()

QarResult qar_render_sender_subscribe_requests (QarSession * session, qar_render_sender_request_callback_t callback, void * user_state, QarCancelToken * token)

inline static

Subscribe to pending render stream requests for this session.

Definition at line 1722 of file qar_streaming.h.

qar_render_stream_handle_destroy()

void qar_render_stream_handle_destroy (QarRenderSender * handle)

inline static

Destroy a render stream sender handle.

Definition at line 1720 of file qar_streaming.h.

---

Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.