fife-parpg: engine/core/video/renderbackend.h annotate

annotate engine/core/video/renderbackend.h @ 643:edf6dcfe8cd4

* Modified the way we detect valid resolutions because SDL_VideoModeOK() was unreliable on a Mac when passed values returned from SDL_ListModes(). It now uses a pre-canned list of common resolutions to check.

author	prock@33b003aa-7bff-0310-803a-e67f0ece8222
date	Sat, 09 Oct 2010 17:00:33 +0000
parents	6e2151325017
children	01acc9fc35ea

rev	line source
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	1 /***************************************************************************
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	2 * Copyright (C) 2005-2008 by the FIFE team *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	3 * http://www.fifengine.de *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	4 * This file is part of FIFE. *
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	5 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	6 * FIFE is free software; you can redistribute it and/or *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	7 * modify it under the terms of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	8 * License as published by the Free Software Foundation; either *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	9 * version 2.1 of the License, or (at your option) any later version. *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	10 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	11 * This library is distributed in the hope that it will be useful, *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	14 * Lesser General Public License for more details. *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	15 * *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	16 * You should have received a copy of the GNU Lesser General Public *
90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	17 * License along with this library; if not, write to the *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	18 * Free Software Foundation, Inc., *
46 90005975cdbb * Final LGPL switch step by adjusting the file headers mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 0 diff changeset	19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	20 ***************************************************************************/
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	21
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	22 #ifndef FIFE_VIDEO_RENDERBACKEND_H
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	23 #define FIFE_VIDEO_RENDERBACKEND_H
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	24
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	25 // Standard C++ library includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	26 #include <string>
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	27
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	28 // Platform specific includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	29 #include "util/base/fife_stdint.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	30
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	31 // 3rd party library includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	32 #include <SDL.h>
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	33 #include <SDL_video.h>
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	34
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	35 // FIFE includes
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	36 // These includes are split up in two parts, separated by one empty line
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	37 // First block: files included from the FIFE root src directory
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	38 // Second block: files included from the same folder
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39 #include "util/base/singleton.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 #include "util/structures/point.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	41 #include "util/structures/rect.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	42
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	43 #include "image.h"
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	44
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	45 namespace FIFE {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	46
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	47 class Image;
635 3094988564d5 * Added a simple method to query the default video card capabilities. This is still a work in progress. You can now get a list of ScreenModes the device supports. ScreenMode includes information on the screen resolution, if the mode is fullscreen/windowed and if it would use the OpenGL or SDL renderer. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 634 diff changeset	48 class ScreenMode;
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50 /** Abstract interface for all the renderbackends. */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	51 class RenderBackend: public AbstractImage, public DynamicSingleton<RenderBackend> {
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	52 public:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	53 /** Constructor.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	54 * @param name The name of the new renderbackend.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	55 */
425 ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	56 RenderBackend(const SDL_Color& colorkey);
621 356634098bd9 * Removed the image chunking size variable from engine settings. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 579 diff changeset	57
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 /** Destructor.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	59 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60 virtual ~RenderBackend();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	62 /** The name of the renderbackend.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63 * @return The name of this renderbackend.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	64 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	65 virtual const std::string& getName() const = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	66
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	67 /** Called when a new frame starts.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	68 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	69 virtual void startFrame() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	70
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	71 /** Called when a frame is finished and ready to be displayed.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	72 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	73 virtual void endFrame() = 0;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	75 /** Initializes the backend.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	76 */
640 855ad500f991 * Added the ability to set/get the video driver used using the settings interface. Note that the default driver for the OS will be used unless explicitly specified. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 635 diff changeset	77 virtual void init(const std::string& driver) = 0;
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	78
634 5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	79 /** Forces a clear of the backbuffer
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	80 */
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	81 virtual void clearBackBuffer() = 0;
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	82
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	83 /** Performs cleanup actions.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	85 virtual void deinit();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	86
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	87 /** Creates the mainscreen (the display window).
642 6e2151325017 * Added the ability to query the current running screen mode prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 640 diff changeset	88 * @param mode The ScreenMode to use. @see FIFE::ScreenMode.
6e2151325017 * Added the ability to query the current running screen mode prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 640 diff changeset	89 * @param tite The window title to use.
6e2151325017 * Added the ability to query the current running screen mode prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 640 diff changeset	90 * @param icon The window icon to use.
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	91 * @return The new Screen Image
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	92 */
642 6e2151325017 * Added the ability to query the current running screen mode prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 640 diff changeset	93 virtual Image* createMainScreen(const ScreenMode& mode, const std::string& title, const std::string& icon) = 0;
635 3094988564d5 * Added a simple method to query the default video card capabilities. This is still a work in progress. You can now get a list of ScreenModes the device supports. ScreenMode includes information on the screen resolution, if the mode is fullscreen/windowed and if it would use the OpenGL or SDL renderer. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 634 diff changeset	94
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	95 /** Creates an Image suitable for this renderbackend.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	96 * @param data Pointer to the imagedata (needs to be in RGBA, 8 bits per channel).
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	97 * @param width Width of the image.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	98 * @param height Height of the image.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	99 * @return The new Image.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	100 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	101 virtual Image* createImage(const uint8_t* data, unsigned int width, unsigned int height) = 0;
621 356634098bd9 * Removed the image chunking size variable from engine settings. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 579 diff changeset	102
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	103 /** Helper function to create images from SDL_Surfaces.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	104 * Takes ownership over the surface.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	105 * @param surface The surface to convert.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	106 * @return The new Image.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	107 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	108 virtual Image* createImage(SDL_Surface* surface) = 0;
579 b2feacaed53c * Added the colorbuffer patch with a small change due to SDL. Performance boost between 20-30% under OpenGL. helios2000@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 425 diff changeset	109
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	110 /** Returns a pointer to the main screen Image
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	111 * @return A pointer to the main screen Image, or 0 if no mainscreen exists.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	112 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	113 Image* getScreenImage() const { return m_screen; };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	114
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	115 /** Creates a Screenshot and saves it to a file.
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	116 */
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	117 void captureScreen(const std::string& filename);
621 356634098bd9 * Removed the image chunking size variable from engine settings. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 579 diff changeset	118
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	119 SDL_Surface* getSurface();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	120 unsigned int getWidth() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	121 unsigned int getHeight() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	122 unsigned int getScreenWidth() const { return getWidth(); }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	123 unsigned int getScreenHeight() const { return getHeight(); }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	124 const Rect& getArea();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	125 void getPixelRGBA(int x, int y, uint8_t* r, uint8_t* g, uint8_t* b, uint8_t* a);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	126 void pushClipArea(const Rect& cliparea, bool clear=true);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	127 void popClipArea();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	128 const Rect& getClipArea() const;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	129 void setAlphaOptimizerEnabled(bool enabled);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	130 bool isAlphaOptimizerEnabled();
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	131 void saveImage(const std::string& filename);
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	132
425 ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	133 /** Sets whether to use the colorkey feature
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	134 */
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	135 void setColorKeyEnabled(bool colorkeyenable);
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	136
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	137 /** Gets whether the colorkey feature is in use
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	138 */
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	139 bool isColorKeyEnabled() const;
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	140
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	141 /** Sets the global colorkey to use for images
621 356634098bd9 * Removed the image chunking size variable from engine settings. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 579 diff changeset	142 */
425 ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	143 void setColorKey(const SDL_Color& colorkey);
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	144
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	145 /** Gets the global colorkey setting
621 356634098bd9 * Removed the image chunking size variable from engine settings. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 579 diff changeset	146 */
425 ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	147 const SDL_Color& getColorKey() const;
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	148
634 5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	149 /** Sets if the backbuffer should be cleared before rendering the next frame.
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	150 * @param clear true = clear screen before next frame, false = do not clear screen
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	151 */
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	152 void setClearBackBuffer(bool clear) { m_clear = clear; };
5f381fa34769 * Added the clearBackBuffer() function to the renderbackends. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 633 diff changeset	153
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	154 protected:
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	155 Image* m_screen;
633 46b95d06c8c2 * Renamed RenderBackend::isClearNeeded() to RenderBackend::setClearScreen(). It is no longer pure virtual. Also documented it's functionality. prock@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 621 diff changeset	156 bool m_clear;
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	157 bool m_isalphaoptimized;
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	158 unsigned int m_chunkingsize;
425 ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	159 bool m_iscolorkeyenabled;
ad7969d9460b A client can now specify a global color key to be used with all images. The default color key is (255,0,255) in RGB format. Also the client can enable/disable the color key feature by using the setColorKeyEnabled function in the EngineSettings class. By default the color key feature is disabled. fixes[t:451] vtchill@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 61 diff changeset	160 SDL_Color m_colorkey;
0 4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	161 };
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	162 }
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	163
4a0efb7baf70 * Datasets becomes the new trunk and retires after that :-) mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	164 #endif

Mercurial > fife-parpg

annotate engine/core/video/renderbackend.h @ 643:edf6dcfe8cd4