openttd-ottdgrfs: comparison src/blitter/base.hpp

equal deleted inserted replaced

-:b5c2449616b5
+:66dde6412125
 		int sprite_height;       ///< Real height of the sprite
 		int left, top;           ///< The offset in the 'dst' in pixels to start drawing
 		void *dst;               ///< Destination buffer
 		int pitch;               ///< The pitch of the destination buffer
+	};
+	enum PaletteAnimation {
+		PALETTE_ANIMATION_NONE,           ///< No palette animation
+		PALETTE_ANIMATION_VIDEO_BACKEND,  ///< Palette animation should be done by video backend (8bpp only!)
+		PALETTE_ANIMATION_BLITTER,        ///< The blitter takes care of the palette animation
 	};
 	typedef void *AllocatorProc(size_t size);
 	/**
 	 * Make a single horizontal line in a single color on the video-buffer.
 	 * @param video The destination pointer (video-buffer).
 	 * @param width The lenght of the line.
 	 * @param color A 8bpp mapping color.
 	 */
-	virtual void SetHorizontalLine(void *video, int width, uint8 color) = 0;
+	virtual void DrawRect(void *video, int width, int height, uint8 color) = 0;
+	/**
+	 * Draw a line with a given color.
+	 * @param video The destination pointer (video-buffer).
+	 * @param x The x coordinate from where the line starts.
+	 * @param y The y coordinate from where the line starts.
+	 * @param x2 The x coordinate to where the line goes.
+	 * @param y2 The y coordinate to where the lines goes.
+	 * @param screen_width The width of the screen you are drawing in (to avoid buffer-overflows).
+	 * @param screen_height The height of the screen you are drawing in (to avoid buffer-overflows).
+	 * @param color A 8bpp mapping color.
+	 */
+	virtual void DrawLine(void *video, int x, int y, int x2, int y2, int screen_width, int screen_height, uint8 color) = 0;
 	/**
 	 * Copy from a buffer to the screen.
 	 * @param video The destionation pointer (video-buffer).
 	 * @param src The buffer from which the data will be read.
 	 * @param width The width of the buffer.
 	 * @param height The height of the buffer.
-	 * @param src_pitch The pitch (byte per line) of the source buffer.
+	 * @note You can not do anything with the content of the buffer, as the blitter can store non-pixel data in it too!
 	 */
-	virtual void CopyFromBuffer(void *video, const void *src, int width, int height, int src_pitch) = 0;
+	virtual void CopyFromBuffer(void *video, const void *src, int width, int height) = 0;
 	/**
 	 * Copy from the screen to a buffer.
 	 * @param video The destination pointer (video-buffer).
 	 * @param dst The buffer in which the data will be stored.
 	 * @param width The width of the buffer.
 	 * @param height The height of the buffer.
+	 * @note You can not do anything with the content of the buffer, as the blitter can store non-pixel data in it too!
+	 */
+	virtual void CopyToBuffer(const void *video, void *dst, int width, int height) = 0;
+	/**
+	 * Copy from the screen to a buffer in a palette format for 8bpp and RGBA format for 32bpp.
+	 * @param video The destination pointer (video-buffer).
+	 * @param dst The buffer in which the data will be stored.
+	 * @param width The width of the buffer.
+	 * @param height The height of the buffer.
 	 * @param dst_pitch The pitch (byte per line) of the destination buffer.
 	 */
-	virtual void CopyToBuffer(const void *video, void *dst, int width, int height, int dst_pitch) = 0;
+	virtual void CopyImageToBuffer(const void *video, void *dst, int width, int height, int dst_pitch) = 0;
 	/**
-	 * Move the videobuffer some places (via memmove).
+	 * Scroll the videobuffer some 'x' and 'y' value.
-	 * @param video_dst The destination pointer (video-buffer).
+	 * @param video The buffer to scroll into.
-	 * @param video_src The source pointer (video-buffer).
+	 * @param left The left value of the screen to scroll.
-	 * @param width The width of the buffer to move.
+	 * @param top The top value of the screen to scroll.
-	 * @param height The height of the buffer to move.
+	 * @param width The width of the screen to scroll.
+	 * @param height The height of the screen to scroll.
+	 * @param scroll_x How much to scroll in X.
+	 * @param scroll_y How much to scroll in Y.
 	 */
-	virtual void MoveBuffer(void *video_dst, const void *video_src, int width, int height) = 0;
+	virtual void ScrollBuffer(void *video, int &left, int &top, int &width, int &height, int scroll_x, int scroll_y) = 0;
 	/**
 	 * Calculate how much memory there is needed for an image of this size in the video-buffer.
 	 * @param width The width of the buffer-to-be.
 	 * @param height The height of the buffer-to-be.
 	 * @return The size needed for the buffer.
 	 */
 	virtual int BufferSize(int width, int height) = 0;
+	/**
+	 * Called when the 8bpp palette is changed; you should redraw all pixels on the screen that
+	 *  are equal to the 8bpp palette indexes 'start' to 'start + count'.
+	 * @param start The start index in the 8bpp palette.
+	 * @param count The amount of indexes that are (possible) changed.
+	 */
+	virtual void PaletteAnimate(uint start, uint count) = 0;
+	/**
+	 * Check if the blitter uses palette animation at all.
+	 * @return True if it uses palette animation.
+	 */
+	virtual Blitter::PaletteAnimation UsePaletteAnimation() = 0;
+	/**
+	 * Get the naem of the blitter, the same as the Factory-instance returns.
+	 */
+	virtual const char *GetName() = 0;
 	virtual ~Blitter() { }
 };
 #endif /* BLITTER_BASE_HPP */

branch	noai
changeset 9629	66dde6412125
parent 9628	b5c2449616b5
child 9723	eee46cb39750