Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CGUISurroundRenderer Class Reference

Fills the part of the raster the interface leaves uncovered while it holds its shape. The viewer's choice wins, then the skin's <surround>; an unpainted band is black. More...

#include <GUISurroundRenderer.h>

Public Member Functions

 CGUISurroundRenderer ()
 
 ~CGUISurroundRenderer ()
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyRegions)
 Place the surround image and run its process phase, which applies its fit and polls a texture still loading. Call on every frame, before Render().
 
void Render ()
 Paint the surround: before the window, only in the leftover bands, under a clip lifted to the raster and no further.
 
void Invalidate ()
 Forget what the surround is painted with, so the next frame resolves it again. Call when a surround setting moves or the skin changes.
 
void ReleaseResources ()
 Let go of the image and its texture handle. Call on GUI shutdown, before the texture system goes.
 

Detailed Description

Fills the part of the raster the interface leaves uncovered while it holds its shape. The viewer's choice wins, then the skin's <surround>; an unpainted band is black.

Constructor & Destructor Documentation

◆ CGUISurroundRenderer()

CGUISurroundRenderer::CGUISurroundRenderer ( )
default

◆ ~CGUISurroundRenderer()

CGUISurroundRenderer::~CGUISurroundRenderer ( )
default

Member Function Documentation

◆ Invalidate()

void CGUISurroundRenderer::Invalidate ( )

Forget what the surround is painted with, so the next frame resolves it again. Call when a surround setting moves or the skin changes.

◆ Process()

void CGUISurroundRenderer::Process ( unsigned int currentTime,
CDirtyRegionList & dirtyRegions )

Place the surround image and run its process phase, which applies its fit and polls a texture still loading. Call on every frame, before Render().

◆ ReleaseResources()

void CGUISurroundRenderer::ReleaseResources ( )

Let go of the image and its texture handle. Call on GUI shutdown, before the texture system goes.

◆ Render()

void CGUISurroundRenderer::Render ( )

Paint the surround: before the window, only in the leftover bands, under a clip lifted to the raster and no further.


The documentation for this class was generated from the following files: