OpenTTD Source  20240917-master-g9ab0a47812
8bpp_simple.cpp
Go to the documentation of this file.
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 
10 #include "../stdafx.h"
11 #include "../zoom_func.h"
12 #include "8bpp_simple.hpp"
13 
14 #include "../safeguards.h"
15 
18 
20 {
21  const uint8_t *src, *src_line;
22  uint8_t *dst, *dst_line;
23 
24  /* Find where to start reading in the source sprite */
25  src_line = (const uint8_t *)bp->sprite + (bp->skip_top * bp->sprite_width + bp->skip_left) * ScaleByZoom(1, zoom);
26  dst_line = (uint8_t *)bp->dst + bp->top * bp->pitch + bp->left;
27 
28  for (int y = 0; y < bp->height; y++) {
29  dst = dst_line;
30  dst_line += bp->pitch;
31 
32  src = src_line;
33  src_line += bp->sprite_width * ScaleByZoom(1, zoom);
34 
35  for (int x = 0; x < bp->width; x++) {
36  uint colour = 0;
37 
38  switch (mode) {
39  case BM_COLOUR_REMAP:
40  case BM_CRASH_REMAP:
41  colour = bp->remap[*src];
42  break;
43 
44  case BM_TRANSPARENT:
46  if (*src != 0) colour = bp->remap[*dst];
47  break;
48 
49  case BM_BLACK_REMAP:
50  if (*src != 0) *dst = 0;
51  break;
52 
53  default:
54  colour = *src;
55  break;
56  }
57  if (colour != 0) *dst = colour;
58  dst++;
59  src += ScaleByZoom(1, zoom);
60  }
61  }
62 }
63 
65 {
66  Sprite *dest_sprite;
67  dest_sprite = allocator.Allocate<Sprite>(sizeof(*dest_sprite) + static_cast<size_t>(sprite[ZOOM_LVL_MIN].height) * static_cast<size_t>(sprite[ZOOM_LVL_MIN].width));
68 
69  dest_sprite->height = sprite[ZOOM_LVL_MIN].height;
70  dest_sprite->width = sprite[ZOOM_LVL_MIN].width;
71  dest_sprite->x_offs = sprite[ZOOM_LVL_MIN].x_offs;
72  dest_sprite->y_offs = sprite[ZOOM_LVL_MIN].y_offs;
73 
74  /* Copy over only the 'remap' channel, as that is what we care about in 8bpp */
75  for (int i = 0; i < sprite[ZOOM_LVL_MIN].height * sprite[ZOOM_LVL_MIN].width; i++) {
76  dest_sprite->data[i] = sprite[ZOOM_LVL_MIN].data[i].m;
77  }
78 
79  return dest_sprite;
80 }
Sprite::height
uint16_t height
Height of the sprite.
Definition: spritecache.h:18
8bpp_simple.hpp
FBlitter_8bppSimple
Factory for the most trivial 8bpp blitter.
Definition: 8bpp_simple.hpp:26
Sprite::x_offs
int16_t x_offs
Number of pixels to shift the sprite to the right.
Definition: spritecache.h:20
Blitter::BlitterParams::top
int top
The top offset in the 'dst' in pixels to start drawing.
Definition: base.hpp:43
BM_TRANSPARENT
@ BM_TRANSPARENT
Perform transparency darkening remapping.
Definition: base.hpp:20
Blitter::BlitterParams::skip_left
int skip_left
How much pixels of the source to skip on the left (based on zoom of dst)
Definition: base.hpp:36
BlitterMode
BlitterMode
The modes of blitting we can do.
Definition: base.hpp:17
Blitter::BlitterParams::width
int width
The width in pixels that needs to be drawn to dst.
Definition: base.hpp:38
Blitter::BlitterParams::remap
const uint8_t * remap
XXX – Temporary storage for remap array.
Definition: base.hpp:34
Blitter::BlitterParams::dst
void * dst
Destination buffer.
Definition: base.hpp:45
Blitter::BlitterParams::sprite_width
int sprite_width
Real width of the sprite.
Definition: base.hpp:40
Blitter::BlitterParams::pitch
int pitch
The pitch of the destination buffer.
Definition: base.hpp:46
SpriteAllocator
Interface for something that can allocate memory for a sprite.
Definition: spriteloader.hpp:88
SpriteLoader::SpriteCollection
std::array< Sprite, ZOOM_LVL_END > SpriteCollection
Type defining a collection of sprites, one for each zoom level.
Definition: spriteloader.hpp:70
ZOOM_LVL_MIN
@ ZOOM_LVL_MIN
Minimum zoom level.
Definition: zoom_type.h:41
Blitter::BlitterParams::sprite
const void * sprite
Pointer to the sprite how ever the encoder stored it.
Definition: base.hpp:33
Blitter_8bppSimple::Draw
void Draw(Blitter::BlitterParams *bp, BlitterMode mode, ZoomLevel zoom) override
Draw an image to the screen, given an amount of params defined above.
Definition: 8bpp_simple.cpp:19
BM_COLOUR_REMAP
@ BM_COLOUR_REMAP
Perform a colour remapping.
Definition: base.hpp:19
Sprite::width
uint16_t width
Width of the sprite.
Definition: spritecache.h:19
iFBlitter_8bppSimple
static FBlitter_8bppSimple iFBlitter_8bppSimple
Instantiation of the simple 8bpp blitter factory.
Definition: 8bpp_simple.cpp:17
BM_CRASH_REMAP
@ BM_CRASH_REMAP
Perform a crash remapping.
Definition: base.hpp:22
BM_BLACK_REMAP
@ BM_BLACK_REMAP
Perform remapping to a completely blackened sprite.
Definition: base.hpp:23
SpriteAllocator::Allocate
T * Allocate(size_t size)
Allocate memory for a sprite.
Definition: spriteloader.hpp:99
Sprite::y_offs
int16_t y_offs
Number of pixels to shift the sprite downwards.
Definition: spritecache.h:21
Blitter::BlitterParams::left
int left
The left offset in the 'dst' in pixels to start drawing.
Definition: base.hpp:42
Blitter::BlitterParams
Parameters related to blitting.
Definition: base.hpp:32
Blitter_8bppSimple::Encode
Sprite * Encode(const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override
Convert a sprite from the loader to our own format.
Definition: 8bpp_simple.cpp:64
Blitter::BlitterParams::height
int height
The height in pixels that needs to be drawn to dst.
Definition: base.hpp:39
Sprite::data
uint8_t data[]
Sprite data.
Definition: spritecache.h:22
Blitter::BlitterParams::skip_top
int skip_top
How much pixels of the source to skip on the top (based on zoom of dst)
Definition: base.hpp:37
ScaleByZoom
int ScaleByZoom(int value, ZoomLevel zoom)
Scale by zoom level, usually shift left (when zoom > ZOOM_LVL_MIN) When shifting right,...
Definition: zoom_func.h:22
Sprite
Data structure describing a sprite.
Definition: spritecache.h:17
BM_TRANSPARENT_REMAP
@ BM_TRANSPARENT_REMAP
Perform transparency colour remapping.
Definition: base.hpp:21
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:16