|
Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
|
#include <GraphicContext.h>
Classes | |
| class | UITransform |
Public Member Functions | |
| CGraphicContext (void) | |
| virtual | ~CGraphicContext () |
| float | GetFPS () const |
| void | SetFPS (float fps) |
| float | GetDisplayLatency () const |
| bool | IsFullScreenRoot () const |
| void | ToggleFullScreen () |
| void | SetFullScreenVideo (bool bOnOff) |
| bool | IsFullScreenVideo () const |
| bool | IsValidResolution (RESOLUTION res) |
| void | SetVideoResolution (RESOLUTION res, bool forceUpdate, CEvent *abortEvent=nullptr) |
| Switch the video resolution on the app thread. | |
| void | ApplyModeChange (RESOLUTION res) |
| void | ApplyWindowResize (int newWidth, int newHeight) |
| RESOLUTION | GetVideoResolution () const |
| const RESOLUTION_INFO | GetResInfo () const |
| const RESOLUTION_INFO | GetResInfo (RESOLUTION res) const |
| void | SetResInfo (RESOLUTION res, const RESOLUTION_INFO &info) |
| void | Flip (bool rendered, bool videoLayer) |
| int | GetWidth () const |
| int | GetHeight () const |
| bool | SetViewPort (float fx, float fy, float fwidth, float fheight, bool intersectPrevious=false) |
| void | RestoreViewPort () |
| void | SetScissors (const CRect &rect) |
| void | ResetScissors () |
| const CRect & | GetScissors () const |
| const CRect | GetViewWindow () const |
| void | SetViewWindow (float left, float top, float right, float bottom) |
| bool | SetGuiContentRect (const CRect &rect) |
Confine the GUI to rect, empty for the whole screen. Not persisted, unlike the overscan calibration. | |
| void | SetRasterAspect (float aspect) |
| State the shape of the screen the display is projected onto, or zero for the display's own. Nothing drawn may exceed the raster this defines. | |
| float | GetRasterAspect () const |
| The stated shape of the screen, or zero when the display's own is in force. | |
| bool | IsRasterShapeStated () const |
| Stated, not in force: one suspended while a screen tool is up still counts. | |
| CRect | GetRasterRect () const |
| The raster, in screen coordinates. The whole display when no shape is stated. | |
| RESOLUTION_INFO | GetRasterResInfo () const |
| The resolution sized as the raster, for the skin's layout selection. A selection target, not a drawable resolution. | |
| void | SetGuiKeepShape (bool keepShape) |
| Draw the interface at its authored proportions inside the area in force rather than stretching it to fill. A 16:9 skin in a 2.40 raster is then pillarboxed. | |
| bool | GetGuiKeepShape () const |
| Asked for, not in force - unlike GetGuiKeepShapeRect(), which answers empty while the hold is merely suspended. | |
| CRect | GetGuiKeepShapeRect () const |
| The rectangle the interface is held to, empty whenever no hold is in force. | |
| CRect | ClipToGui () |
| Confine the clip in force to the area the interface occupies. | |
| CRect | ClipToVideo () |
| Lift the clip to the whole display for the picture's render pass, which is contained by scaling rather than by the scissor. | |
| CRect | SetClip (const CRect &rect) |
Clip to exactly rect, re-applying no bound. | |
| bool | IsCalibrating () const |
| Whether a screen tool is on screen. While one is, the raster and the proportions hold are suspended and the tool draws on the raw pixel grid. | |
| void | SetCalibrating (bool bOnOff) |
| void | ResetOverscan (RESOLUTION res, OVERSCAN &overscan) |
| void | ResetOverscan (RESOLUTION_INFO &resinfo) |
| void | ResetScreenParameters (RESOLUTION res) |
| void | CaptureStateBlock () |
| void | ApplyStateBlock () |
| void | Clear () |
| Invalidates color buffer, clears the depth buffer (if used). Will result in undefined color buffer values which will have to be repainted. Has to be called at the beginning of a frame. | |
| void | Clear (KODI::UTILS::COLOR::Color color) |
| Clears the depth buffer (if used) and the color buffer. Guaranties a defined color buffer value. Has to be called at the beginning of a frame. | |
| void | GetAllowedResolutions (std::vector< RESOLUTION > &res) |
| void | SetRenderOrder (RENDER_ORDER renderOrder) |
| Sets the direction of the current rendering pass. | |
| RENDER_ORDER | GetRenderOrder () |
| Returns the current render order mode. | |
| void | ResetDepth () |
| Resets the z-depth. Layer 0 and 1 are reserved as presentation (video) layer. | |
| uint32_t | GetDepth (uint32_t addLayers=2) |
| Reserve layers for the caller to use. | |
| void | GetGUIScaling (const RESOLUTION_INFO &res, float &scaleX, float &scaleY, TransformMatrix *matrix=NULL) |
| void | SetRenderingResolution (const RESOLUTION_INFO &res, bool needsScaling) |
| Sets scaling up for rendering. | |
| void | SetScalingResolution (const RESOLUTION_INFO &res, bool needsScaling) |
| Sets scaling up for skin loading etc. | |
| float | GetScalingPixelRatio () const |
| void | InvertFinalCoords (float &x, float &y) const |
| float | ScaleFinalXCoord (float x, float y) const |
| float | ScaleFinalYCoord (float x, float y) const |
| float | ScaleFinalZCoord (float x, float y) const |
| void | ScaleFinalCoords (float &x, float &y, float &z) const |
| bool | RectIsAngled (float x1, float y1, float x2, float y2) const |
| const TransformMatrix & | GetGUIMatrix () const |
| float | GetGUIScaleX () const |
| float | GetGUIScaleY () const |
| KODI::UTILS::COLOR::Color | MergeAlpha (KODI::UTILS::COLOR::Color color) const |
| KODI::UTILS::COLOR::Color | MergeColor (KODI::UTILS::COLOR::Color color) const |
| void | SetOrigin (float x, float y) |
| void | RestoreOrigin () |
| void | SetCameraPosition (const CPoint &camera) |
| void | SetStereoView (RenderStereoView view) |
| RenderStereoView | GetStereoView () |
| void | SetStereoMode (RenderStereoMode mode) |
| RenderStereoMode | GetStereoMode () |
| void | RestoreCameraPosition () |
| void | SetStereoFactor (float factor) |
| void | RestoreStereoFactor () |
| float | GetTransformDepth (int32_t depthOffset=0) |
| Gets the depth information of the current transform matrix. | |
| float | GetNormalizedDepth (uint32_t depth) |
| Gets the (normalized) depth information. | |
| bool | SetClipRegion (float x, float y, float w, float h) |
| Set a region in which to clip all rendering Anything that is rendered after setting a clip region will be clipped so that no part renders outside of the clip region. Successive calls to SetClipRegion intersect the clip region, which means the clip region may eventually become an empty set. In this case SetClipRegion returns false to indicate that no rendering need be performed. | |
| void | RestoreClipRegion () |
| void | ClipRect (CRect &vertex, CRect &texture, CRect *diffuse=NULL) |
| CRect | GetClipRegion () |
| bool | HasClipRegion () const |
| void | AddGUITransform () |
| TransformMatrix | AddTransform (const TransformMatrix &matrix) |
| void | SetTransform (const TransformMatrix &matrix) |
| void | SetTransform (const TransformMatrix &matrix, float scaleX, float scaleY) |
| void | RemoveTransform () |
| CRect | StereoCorrection (const CRect &rect) const |
| CPoint | StereoCorrection (const CPoint &point) const |
| CRect | GenerateAABB (const CRect &rect) const |
| const std::string & | GetMediaDir () const |
| void | SetMediaDir (const std::string &strMediaDir) |
| void | SetTransferPQ (bool PQ) |
| bool | IsTransferPQ () const |
| STENCIL_LAYER | AddStencilRectToBucket (const CRect &newRect) |
| Reserves an aabb to which a stencil drawcall should be made. Returns the bucket (or rather layer) to which the drawcall has to be applied to. If all 8 available buckets are full for a given area, it will signal so. | |
| void | ClearStencilBuckets () |
| Clears all stencil buckets. Should be called at the start of a new frame. | |
| void | SetStencilLayer (const STENCIL_LAYER stencilLayer) |
| Pushes a new stencil layer to the stack. Child elements should render using this layer. | |
| void | RestoreStencilLayer () |
| Pops the current stencil layer. | |
| STENCIL_LAYER | GetStencilLayer () |
| Returns the current stencil layer. | |
Protected Member Functions | |
| void | UpdateCameraPosition (const CPoint &camera, const float &factor) |
| void | SetVideoResolutionInternal (RESOLUTION res, bool forceUpdate) |
| void | ApplyVideoResolution (RESOLUTION res) |
| void | UpdateInternalStateWithResolution (RESOLUTION res) |
| CRect | ClipBounds () const |
| The furthest anything being drawn may reach: the raster for the interface, the whole display for the picture. | |
| CRect | ScreenRect () const |
| float | RasterAspectInForce () const |
| The stated shape put through ComputeRasterAspectInForce() for the state in hand. | |
| bool | GuiKeepShapeInForce () const |
| The hold put through ComputeGuiKeepShape() for the state in hand. | |
|
default |
|
virtualdefault |
| void CGraphicContext::AddGUITransform | ( | ) |
| STENCIL_LAYER CGraphicContext::AddStencilRectToBucket | ( | const CRect & | newRect | ) |
Reserves an aabb to which a stencil drawcall should be made. Returns the bucket (or rather layer) to which the drawcall has to be applied to. If all 8 available buckets are full for a given area, it will signal so.
| newRect | the requested area the element wants to render to |
| TransformMatrix CGraphicContext::AddTransform | ( | const TransformMatrix & | matrix | ) |
| void CGraphicContext::ApplyModeChange | ( | RESOLUTION | res | ) |
| void CGraphicContext::ApplyStateBlock | ( | ) |
|
protected |
| void CGraphicContext::CaptureStateBlock | ( | ) |
| void CGraphicContext::Clear | ( | ) |
Invalidates color buffer, clears the depth buffer (if used). Will result in undefined color buffer values which will have to be repainted. Has to be called at the beginning of a frame.
| void CGraphicContext::Clear | ( | KODI::UTILS::COLOR::Color | color | ) |
Clears the depth buffer (if used) and the color buffer. Guaranties a defined color buffer value. Has to be called at the beginning of a frame.
| color | the specified color. |
| void CGraphicContext::ClearStencilBuckets | ( | ) |
Clears all stencil buckets. Should be called at the start of a new frame.
|
protected |
The furthest anything being drawn may reach: the raster for the interface, the whole display for the picture.
| CRect CGraphicContext::ClipToGui | ( | ) |
Confine the clip in force to the area the interface occupies.
| CRect CGraphicContext::ClipToVideo | ( | ) |
Lift the clip to the whole display for the picture's render pass, which is contained by scaling rather than by the scissor.
| void CGraphicContext::GetAllowedResolutions | ( | std::vector< RESOLUTION > & | res | ) |
| CRect CGraphicContext::GetClipRegion | ( | ) |
| uint32_t CGraphicContext::GetDepth | ( | uint32_t | addLayers = 2 | ) |
Reserve layers for the caller to use.
| addLayers | number of layers needed |
| float CGraphicContext::GetDisplayLatency | ( | ) | const |
| float CGraphicContext::GetFPS | ( | ) | const |
|
inline |
Asked for, not in force - unlike GetGuiKeepShapeRect(), which answers empty while the hold is merely suspended.
| CRect CGraphicContext::GetGuiKeepShapeRect | ( | ) | const |
The rectangle the interface is held to, empty whenever no hold is in force.
| const TransformMatrix & CGraphicContext::GetGUIMatrix | ( | ) | const |
| float CGraphicContext::GetGUIScaleX | ( | ) | const |
| float CGraphicContext::GetGUIScaleY | ( | ) | const |
| void CGraphicContext::GetGUIScaling | ( | const RESOLUTION_INFO & | res, |
| float & | scaleX, | ||
| float & | scaleY, | ||
| TransformMatrix * | matrix = NULL ) |
| int CGraphicContext::GetHeight | ( | ) | const |
| const std::string & CGraphicContext::GetMediaDir | ( | ) | const |
| float CGraphicContext::GetNormalizedDepth | ( | uint32_t | depth | ) |
Gets the (normalized) depth information.
| depth | to be normalized |
| float CGraphicContext::GetRasterAspect | ( | ) | const |
The stated shape of the screen, or zero when the display's own is in force.
| CRect CGraphicContext::GetRasterRect | ( | ) | const |
The raster, in screen coordinates. The whole display when no shape is stated.
| RESOLUTION_INFO CGraphicContext::GetRasterResInfo | ( | ) | const |
The resolution sized as the raster, for the skin's layout selection. A selection target, not a drawable resolution.
|
inline |
Returns the current render order mode.
| const RESOLUTION_INFO CGraphicContext::GetResInfo | ( | ) | const |
| const RESOLUTION_INFO CGraphicContext::GetResInfo | ( | RESOLUTION | res | ) | const |
| float CGraphicContext::GetScalingPixelRatio | ( | ) | const |
| const CRect & CGraphicContext::GetScissors | ( | ) | const |
| STENCIL_LAYER CGraphicContext::GetStencilLayer | ( | ) |
Returns the current stencil layer.
|
inline |
|
inline |
| float CGraphicContext::GetTransformDepth | ( | int32_t | depthOffset = 0 | ) |
Gets the depth information of the current transform matrix.
| depthOffset | adds an offset to the current depth |
| RESOLUTION CGraphicContext::GetVideoResolution | ( | ) | const |
| const CRect CGraphicContext::GetViewWindow | ( | ) | const |
| int CGraphicContext::GetWidth | ( | ) | const |
|
protected |
The hold put through ComputeGuiKeepShape() for the state in hand.
|
inline |
| void CGraphicContext::InvertFinalCoords | ( | float & | x, |
| float & | y ) const |
| bool CGraphicContext::IsCalibrating | ( | ) | const |
Whether a screen tool is on screen. While one is, the raster and the proportions hold are suspended and the tool draws on the raw pixel grid.
| bool CGraphicContext::IsFullScreenRoot | ( | ) | const |
| bool CGraphicContext::IsFullScreenVideo | ( | ) | const |
|
inline |
Stated, not in force: one suspended while a screen tool is up still counts.
|
inline |
| bool CGraphicContext::IsValidResolution | ( | RESOLUTION | res | ) |
| Color CGraphicContext::MergeAlpha | ( | KODI::UTILS::COLOR::Color | color | ) | const |
| Color CGraphicContext::MergeColor | ( | KODI::UTILS::COLOR::Color | color | ) | const |
|
protected |
The stated shape put through ComputeRasterAspectInForce() for the state in hand.
| bool CGraphicContext::RectIsAngled | ( | float | x1, |
| float | y1, | ||
| float | x2, | ||
| float | y2 ) const |
| void CGraphicContext::RemoveTransform | ( | ) |
|
inline |
Resets the z-depth. Layer 0 and 1 are reserved as presentation (video) layer.
| void CGraphicContext::ResetOverscan | ( | RESOLUTION | res, |
| OVERSCAN & | overscan ) |
| void CGraphicContext::ResetOverscan | ( | RESOLUTION_INFO & | resinfo | ) |
| void CGraphicContext::ResetScissors | ( | ) |
| void CGraphicContext::ResetScreenParameters | ( | RESOLUTION | res | ) |
| void CGraphicContext::RestoreCameraPosition | ( | ) |
| void CGraphicContext::RestoreClipRegion | ( | ) |
| void CGraphicContext::RestoreOrigin | ( | ) |
| void CGraphicContext::RestoreStencilLayer | ( | ) |
Pops the current stencil layer.
| void CGraphicContext::RestoreStereoFactor | ( | ) |
| void CGraphicContext::RestoreViewPort | ( | ) |
| void CGraphicContext::ScaleFinalCoords | ( | float & | x, |
| float & | y, | ||
| float & | z ) const |
| float CGraphicContext::ScaleFinalXCoord | ( | float | x, |
| float | y ) const |
| float CGraphicContext::ScaleFinalYCoord | ( | float | x, |
| float | y ) const |
| float CGraphicContext::ScaleFinalZCoord | ( | float | x, |
| float | y ) const |
|
protected |
Clip to exactly rect, re-applying no bound.
| bool CGraphicContext::SetClipRegion | ( | float | x, |
| float | y, | ||
| float | w, | ||
| float | h ) |
Set a region in which to clip all rendering Anything that is rendered after setting a clip region will be clipped so that no part renders outside of the clip region. Successive calls to SetClipRegion intersect the clip region, which means the clip region may eventually become an empty set. In this case SetClipRegion returns false to indicate that no rendering need be performed.
This call must be matched with a RestoreClipRegion call unless SetClipRegion returns false.
Usage should be of the form:
if (SetClipRegion(x, y, w, h)) { ... perform rendering ... RestoreClipRegion(); }
| x | the left-most coordinate of the clip region |
| y | the top-most coordinate of the clip region |
| w | the width of the clip region |
| h | the height of the clip region |
| void CGraphicContext::SetFPS | ( | float | fps | ) |
Confine the GUI to rect, empty for the whole screen. Not persisted, unlike the overscan calibration.
Draw the interface at its authored proportions inside the area in force rather than stretching it to fill. A 16:9 skin in a 2.40 raster is then pillarboxed.
| void CGraphicContext::SetMediaDir | ( | const std::string & | strMediaDir | ) |
| void CGraphicContext::SetOrigin | ( | float | x, |
| float | y ) |
| void CGraphicContext::SetRasterAspect | ( | float | aspect | ) |
State the shape of the screen the display is projected onto, or zero for the display's own. Nothing drawn may exceed the raster this defines.
| void CGraphicContext::SetRenderingResolution | ( | const RESOLUTION_INFO & | res, |
| bool | needsScaling ) |
Sets scaling up for rendering.
| void CGraphicContext::SetRenderOrder | ( | RENDER_ORDER | renderOrder | ) |
Sets the direction of the current rendering pass.
| renderOrder | direction of the pass |
| void CGraphicContext::SetResInfo | ( | RESOLUTION | res, |
| const RESOLUTION_INFO & | info ) |
| void CGraphicContext::SetScalingResolution | ( | const RESOLUTION_INFO & | res, |
| bool | needsScaling ) |
Sets scaling up for skin loading etc.
| void CGraphicContext::SetStencilLayer | ( | const STENCIL_LAYER | stencilLayer | ) |
Pushes a new stencil layer to the stack. Child elements should render using this layer.
| stencilLayer | the layer which to be added. |
| void CGraphicContext::SetStereoFactor | ( | float | factor | ) |
|
inline |
| void CGraphicContext::SetStereoView | ( | RenderStereoView | view | ) |
| void CGraphicContext::SetTransform | ( | const TransformMatrix & | matrix | ) |
| void CGraphicContext::SetTransform | ( | const TransformMatrix & | matrix, |
| float | scaleX, | ||
| float | scaleY ) |
| void CGraphicContext::SetVideoResolution | ( | RESOLUTION | res, |
| bool | forceUpdate, | ||
| CEvent * | abortEvent = nullptr ) |
Switch the video resolution on the app thread.
| abortEvent | off the app thread, once set drop the switch and stop waiting, unless the app thread has already started it, in which case wait for it to finish |
|
protected |
| bool CGraphicContext::SetViewPort | ( | float | fx, |
| float | fy, | ||
| float | fwidth, | ||
| float | fheight, | ||
| bool | intersectPrevious = false ) |
| void CGraphicContext::SetViewWindow | ( | float | left, |
| float | top, | ||
| float | right, | ||
| float | bottom ) |
| void CGraphicContext::ToggleFullScreen | ( | ) |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
The area the interface occupies, recorded by GetGUIScaling for the clip.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |