Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::GAME::CGameClientStreamHwFramebuffer Class Reference

#include <GameClientStreamHwFramebuffer.h>

Inheritance diagram for KODI::GAME::CGameClientStreamHwFramebuffer:
KODI::GAME::IGameClientStream

Public Member Functions

 CGameClientStreamHwFramebuffer (IHwFramebufferCallback &callback, const game_hw_rendering_properties &hwProperties)
 
 ~CGameClientStreamHwFramebuffer () override=default
 
bool OpenStream (RETRO::IRetroPlayerStream *stream, const game_stream_properties &properties) override
 Open the stream.
 
void CloseStream () override
 Release the RetroPlayer stream resource.
 
bool GetBuffer (unsigned int width, unsigned int height, game_stream_buffer &buffer) override
 Get a buffer for zero-copy stream data.
 
void AddData (const game_stream_packet &packet) override
 Add a data packet to a stream.
 
- Public Member Functions inherited from KODI::GAME::IGameClientStream
virtual ~IGameClientStream ()=default
 
virtual void ReleaseBuffer (game_stream_buffer &buffer)
 Free an allocated buffer.
 

Static Public Member Functions

static void LogHwProperties (const game_hw_rendering_properties &hwProperties)
 

Constructor & Destructor Documentation

◆ CGameClientStreamHwFramebuffer()

CGameClientStreamHwFramebuffer::CGameClientStreamHwFramebuffer ( IHwFramebufferCallback & callback,
const game_hw_rendering_properties & hwProperties )

◆ ~CGameClientStreamHwFramebuffer()

KODI::GAME::CGameClientStreamHwFramebuffer::~CGameClientStreamHwFramebuffer ( )
overridedefault

Member Function Documentation

◆ AddData()

void CGameClientStreamHwFramebuffer::AddData ( const game_stream_packet & packet)
overridevirtual

Add a data packet to a stream.

Parameters
packetThe data packet

Implements KODI::GAME::IGameClientStream.

◆ CloseStream()

void CGameClientStreamHwFramebuffer::CloseStream ( )
overridevirtual

Release the RetroPlayer stream resource.

Implements KODI::GAME::IGameClientStream.

◆ GetBuffer()

bool CGameClientStreamHwFramebuffer::GetBuffer ( unsigned int width,
unsigned int height,
game_stream_buffer & buffer )
overridevirtual

Get a buffer for zero-copy stream data.

Parameters
widthThe framebuffer width, or 0 for no width specified
heightThe framebuffer height, or 0 for no height specified
[out]bufferThe buffer, or unmodified if false is returned

If this returns true, buffer must be freed using ReleaseBuffer().

Returns
True if buffer was set, false otherwise

Reimplemented from KODI::GAME::IGameClientStream.

◆ LogHwProperties()

void CGameClientStreamHwFramebuffer::LogHwProperties ( const game_hw_rendering_properties & hwProperties)
static

◆ OpenStream()

bool CGameClientStreamHwFramebuffer::OpenStream ( RETRO::IRetroPlayerStream * stream,
const game_stream_properties & properties )
overridevirtual

Open the stream.

Parameters
streamThe RetroPlayer resource to take ownership of
Returns
True if the stream was opened, false otherwise

Implements KODI::GAME::IGameClientStream.


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