The Battle for Wesnoth  1.15.0-dev
Public Member Functions | Private Attributes | List of all members
display::blit_helper Class Reference

Helper structure for rendering the terrains. More...

#include <display.hpp>

Public Member Functions

 blit_helper (const blit_helper &)=delete
 
 blit_helper (const drawing_layer layer, const map_location &loc, const int x, const int y, const surface &surf, const SDL_Rect &clip)
 
 blit_helper (const drawing_layer layer, const map_location &loc, const int x, const int y, const std::vector< surface > &surf, const SDL_Rect &clip)
 
int x () const
 
int y () const
 
const std::vector< surface > & surf () const
 
const SDL_Rect & clip () const
 
bool operator< (const blit_helper &rhs) const
 

Private Attributes

int x_
 x screen coordinate to render at. More...
 
int y_
 y screen coordinate to render at. More...
 
std::vector< surfacesurf_
 surface(s) to render. More...
 
SDL_Rect clip_
 The clipping area of the source if omitted the entire source is used. More...
 
drawing_buffer_key key_
 

Detailed Description

Helper structure for rendering the terrains.

Definition at line 929 of file display.hpp.

Constructor & Destructor Documentation

◆ blit_helper() [1/3]

display::blit_helper::blit_helper ( const blit_helper )
delete

◆ blit_helper() [2/3]

display::blit_helper::blit_helper ( const drawing_layer  layer,
const map_location loc,
const int  x,
const int  y,
const surface surf,
const SDL_Rect &  clip 
)
inline

Definition at line 936 of file display.hpp.

◆ blit_helper() [3/3]

display::blit_helper::blit_helper ( const drawing_layer  layer,
const map_location loc,
const int  x,
const int  y,
const std::vector< surface > &  surf,
const SDL_Rect &  clip 
)
inline

Definition at line 943 of file display.hpp.

Member Function Documentation

◆ clip()

const SDL_Rect& display::blit_helper::clip ( ) const
inline

Definition at line 953 of file display.hpp.

◆ operator<()

bool display::blit_helper::operator< ( const blit_helper rhs) const
inline

Definition at line 955 of file display.hpp.

References key_.

◆ surf()

const std::vector<surface>& display::blit_helper::surf ( ) const
inline

Definition at line 952 of file display.hpp.

◆ x()

int display::blit_helper::x ( ) const
inline

Definition at line 950 of file display.hpp.

◆ y()

int display::blit_helper::y ( ) const
inline

Definition at line 951 of file display.hpp.

Member Data Documentation

◆ clip_

SDL_Rect display::blit_helper::clip_
private

The clipping area of the source if omitted the entire source is used.

Definition at line 961 of file display.hpp.

◆ key_

drawing_buffer_key display::blit_helper::key_
private

Definition at line 965 of file display.hpp.

Referenced by operator<().

◆ surf_

std::vector<surface> display::blit_helper::surf_
private

surface(s) to render.

Definition at line 960 of file display.hpp.

◆ x_

int display::blit_helper::x_
private

x screen coordinate to render at.

Definition at line 958 of file display.hpp.

◆ y_

int display::blit_helper::y_
private

y screen coordinate to render at.

Definition at line 959 of file display.hpp.


The documentation for this class was generated from the following file: