base.hpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef BLITTER_BASE_HPP
#define BLITTER_BASE_HPP
 
#include "../spritecache.h"
#include "../spriteloader/spriteloader.hpp"
 
enum BlitterMode {
  BM_NORMAL,       
  BM_COLOUR_REMAP, 
  BM_TRANSPARENT,  
  BM_TRANSPARENT_REMAP, 
  BM_CRASH_REMAP,  
  BM_BLACK_REMAP,  
};
 
class Blitter : public SpriteEncoder {
public:
  struct BlitterParams {
    const void *sprite; 
    const uint8_t *remap;  
 
    int skip_left;      
    int skip_top;       
    int width;          
    int height;         
    int sprite_width;   
    int sprite_height;  
    int left;           
    int top;            
 
    void *dst;          
    int pitch;          
  };
 
  enum PaletteAnimation {
    PALETTE_ANIMATION_NONE,           
    PALETTE_ANIMATION_VIDEO_BACKEND,  
    PALETTE_ANIMATION_BLITTER,        
  };
 
  virtual uint8_t GetScreenDepth() = 0;
 
  bool Is32BppSupported() override
  {
    return this->GetScreenDepth() > 8;
  }
 
  virtual void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) = 0;
 
  virtual void DrawColourMappingRect(void *dst, int width, int height, PaletteID pal) = 0;
 
  virtual void *MoveTo(void *video, int x, int y) = 0;
 
  virtual void SetPixel(void *video, int x, int y, uint8_t colour) = 0;
 
  virtual void DrawRect(void *video, int width, int height, uint8_t colour) = 0;
 
  virtual void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8_t colour, int width, int dash = 0) = 0;
 
  virtual void CopyFromBuffer(void *video, const void *src, int width, int height) = 0;
 
  virtual void CopyToBuffer(const void *video, void *dst, int width, int height) = 0;
 
  virtual void CopyImageToBuffer(const void *video, void *dst, int width, int height, int dst_pitch) = 0;
 
  virtual void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y) = 0;
 
  virtual size_t BufferSize(uint width, uint height) = 0;
 
  virtual void PaletteAnimate(const Palette &palette) = 0;
 
  virtual Blitter::PaletteAnimation UsePaletteAnimation() = 0;
 
  virtual bool NeedsAnimationBuffer()
  {
    return false;
  }
 
  virtual std::string_view GetName() = 0;
 
  virtual void PostResize() { };
 
  virtual ~Blitter() = default;
 
  template <typename SetPixelT> void DrawLineGeneric(int x, int y, int x2, int y2, int screen_width, int screen_height, int width, int dash, SetPixelT set_pixel);
};
 
#endif /* BLITTER_BASE_HPP */