openMSX
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openmsx::SuperImposedFrame Class Reference

This class represents a frame that is the (per-pixel) alpha-blend of two other frames. More...

#include <SuperImposedFrame.hh>

Inheritance diagram for openmsx::SuperImposedFrame:
Inheritance graph
[legend]
Collaboration diagram for openmsx::SuperImposedFrame:
Collaboration graph
[legend]

Public Member Functions

void init (const FrameSource *top, const FrameSource *bottom)
 
virtual ~SuperImposedFrame ()=default
 
- Public Member Functions inherited from openmsx::FrameSource
void init (FieldType fieldType_)
 (Re)initialize an existing FrameSource. More...
 
FieldType getField () const
 Gets the role this frame plays in interlacing. More...
 
unsigned getHeight () const
 Gets the number of lines in this frame. More...
 
virtual unsigned getLineWidth (unsigned line) const =0
 Gets the number of display pixels on the given line. More...
 
unsigned getWidth () const
 Get the width of (all) lines in this frame. More...
 
template<std::unsigned_integral Pixel>
Pixel getLineColor (unsigned line) const
 Get the (single) color of the given line. More...
 
template<std::unsigned_integral Pixel>
std::span< const PixelgetLine (int line, std::span< Pixel > buf) const
 Gets a pointer to the pixels of the given line number. More...
 
virtual const void * getLineInfo (unsigned line, unsigned &lineWidth, void *buf, unsigned bufWidth) const =0
 Abstract implementation of getLinePtr(). More...
 
template<std::unsigned_integral Pixel>
std::span< const Pixel, 320 > getLinePtr320_240 (unsigned line, std::span< Pixel, 320 > buf) const
 Get a pointer to a given line in this frame, the frame is scaled to 320x240 pixels. More...
 
template<std::unsigned_integral Pixel>
std::span< const Pixel, 640 > getLinePtr640_480 (unsigned line, std::span< Pixel, 640 > buf) const
 Get a pointer to a given line in this frame, the frame is scaled to 640x480 pixels. More...
 
template<std::unsigned_integral Pixel>
std::span< const Pixel, 960 > getLinePtr960_720 (unsigned line, std::span< Pixel, 960 > buf) const
 Get a pointer to a given line in this frame, the frame is scaled to 960x720 pixels. More...
 
const PixelFormatgetPixelFormat () const
 

Static Public Member Functions

static std::unique_ptr< SuperImposedFramecreate (const PixelFormat &format)
 

Protected Member Functions

 SuperImposedFrame (const PixelFormat &format)
 
- Protected Member Functions inherited from openmsx::FrameSource
 FrameSource (const PixelFormat &format)
 
 ~FrameSource ()=default
 
void setHeight (unsigned height_)
 
virtual bool hasContiguousStorage () const
 Returns true when two consecutive rows are also consecutive in memory. More...
 
template<std::unsigned_integral Pixel>
void scaleLine (std::span< const Pixel > in, std::span< Pixel > out) const
 

Protected Attributes

const FrameSourcetop
 
const FrameSourcebottom
 

Additional Inherited Members

- Public Types inherited from openmsx::FrameSource
enum  FieldType { FIELD_NONINTERLACED , FIELD_EVEN , FIELD_ODD }
 What role does this frame play in interlacing? More...
 

Detailed Description

This class represents a frame that is the (per-pixel) alpha-blend of two other frames.

When the two input frames have a different resolution. The result will have the highest resolution of the two inputs (in other words, the lower resolution frame gets upscaled to the higher resolution).

Definition at line 14 of file SuperImposedFrame.hh.

Constructor & Destructor Documentation

◆ ~SuperImposedFrame()

virtual openmsx::SuperImposedFrame::~SuperImposedFrame ( )
virtualdefault

◆ SuperImposedFrame()

openmsx::SuperImposedFrame::SuperImposedFrame ( const PixelFormat format)
explicitprotected

Definition at line 48 of file SuperImposedFrame.cc.

References openmsx::DiskImageUtils::format().

Member Function Documentation

◆ create()

std::unique_ptr< SuperImposedFrame > openmsx::SuperImposedFrame::create ( const PixelFormat format)
static

◆ init()

void openmsx::SuperImposedFrame::init ( const FrameSource top,
const FrameSource bottom 
)

Member Data Documentation

◆ bottom

const FrameSource* openmsx::SuperImposedFrame::bottom
protected

Definition at line 27 of file SuperImposedFrame.hh.

Referenced by init().

◆ top

const FrameSource* openmsx::SuperImposedFrame::top
protected

Definition at line 26 of file SuperImposedFrame.hh.

Referenced by init().


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