src/viewport_sprite_sorter.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * 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.
   4  * 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.
   5  * 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/>.
   6  */
   7
   8 /** @file viewport_sprite_sorter.h Types related to sprite sorting. */
   9
  10 #include "stdafx.h"
  11 #include "gfx_type.h"
  12
  13 #ifndef VIEWPORT_SPRITE_SORTER_H
  14 #define VIEWPORT_SPRITE_SORTER_H
  15
  16 /** Parent sprite that should be drawn */
  17 struct ParentSpriteToDraw {
  18         /* Block of 16B loadable in xmm register */
  19         int32_t xmin;                     ///< minimal world X coordinate of bounding box
  20         int32_t ymin;                     ///< minimal world Y coordinate of bounding box
  21         int32_t zmin;                     ///< minimal world Z coordinate of bounding box
  22         int32_t x;                        ///< screen X coordinate of sprite
  23
  24         /* Second block of 16B loadable in xmm register */
  25         int32_t xmax;                     ///< maximal world X coordinate of bounding box
  26         int32_t ymax;                     ///< maximal world Y coordinate of bounding box
  27         int32_t zmax;                     ///< maximal world Z coordinate of bounding box
  28         int32_t y;                        ///< screen Y coordinate of sprite
  29
  30         SpriteID image;                 ///< sprite to draw
  31         PaletteID pal;                  ///< palette to use
  32         const SubSprite *sub;           ///< only draw a rectangular part of the sprite
  33
  34         int32_t left;                     ///< minimal screen X coordinate of sprite (= x + sprite->x_offs), reference point for child sprites
  35         int32_t top;                      ///< minimal screen Y coordinate of sprite (= y + sprite->y_offs), reference point for child sprites
  36
  37         int32_t first_child;              ///< the first child to draw.
  38         uint32_t order;                   ///< Used during sprite sorting
  39 };
  40
  41 typedef std::vector<ParentSpriteToDraw*> ParentSpriteToSortVector;
  42
  43 /** Type for method for checking whether a viewport sprite sorter exists. */
  44 typedef bool (*VpSorterChecker)();
  45 /** Type for the actual viewport sprite sorter. */
  46 typedef void (*VpSpriteSorter)(ParentSpriteToSortVector *psd);
  47
  48 #ifdef WITH_SSE
  49 bool ViewportSortParentSpritesSSE41Checker();
  50 void ViewportSortParentSpritesSSE41(ParentSpriteToSortVector *psdv);
  51 #endif
  52
  53 void InitializeSpriteSorter();
  54
  55 #endif /* VIEWPORT_SPRITE_SORTER_H */