Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rectalogic committed Apr 19, 2024
1 parent dd25a76 commit 065554b
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions src/MediaFX/render_session.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@
\qmltype RenderSession
//! \instantiates RenderSession
\inqmlmodule MediaFX
\brief The RenderSession singleton provides access to the current rendering time interval.
\brief The RenderSession singleton manages the current rendering session.
XXX fix
Internally, RenderSession manages the set of active MediaClips.
It also exposes access to the \l Window hosting the QML, and the current rendering time.
Internally, RenderSession drives rendering the set of active MediaClips.
It also exposes access to the current rendering time
and allows the session to be shut down, see \l {RenderSession::endSession}.
*/

/*!
Expand All @@ -36,19 +36,6 @@ XXX fix
The current frame interval being rendered, independent of any individual MediaClip.
*/

/*!
\qmlproperty Window RenderSession::window
Provides access to the \l Window hosting the QML.
For example, to set the \l [QML]{Window::color} to a palette entry:
\qml
Item {
Component.onCompleted: RenderSession.window.color = RenderSession.window.palette.window
}
\endqml
*/

/*!
\qmlmethod interval RenderSession::createInterval(int start, int end)
Expand Down

0 comments on commit 065554b

Please sign in to comment.