$treeview $search $mathjax
Stratagus  2.2.6
$projectbrief
$projectbrief
$searchbox
-->
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
           Stratagus - A free fantasy real time strategy game engine

src/video/intern_video.h File Reference

Go to the source code of this file.

#define CLIP_RECTANGLE(x, y, width, height)
 current clipping bottom right
#define CLIP_RECTANGLE_OFS(x, y, width, height, ofsx, ofsy, endx)
int ClipX1
 Profile, frames out of sync.
int ClipY1
 current clipping top left
int ClipX2
 current clipping top left
int ClipY2
 current clipping bottom right

Detailed Description

THIS HEADER FILE SHOULD ONLY BE INCLUDED BY SOURCE-FILES IN VIDEO !!!

This delivers an interface to basic video operations in video.c, while keeping these detailed operations out of the main include-file video.h

Todo:
FIXME: Currently some interfaces listed in video.h should be moved in here, this includes possible "extern" declarations in source-files themselves. The doxygen docs looks not good, but now contains all info.

Define Documentation

#define CLIP_RECTANGLE ( x,
y,
width,
height   ) 

current clipping bottom right

Clip rectangle area to clipping rectangle. This means given arguments can be changed to take the clipping rectangle into account.

Todo:
FIXME: not easy to debug, but making it a function needs:
  • pointers to be able to alter given arguments
  • special return value to denote 'outside' clipping region (which is now handled by a simple return in caller function)
Parameters:
x int X screen pixel position
y int Y screen pixel position (return value of X and Y can be made larger)
width unsigned int width to display
height unsigned int height to display (return value of width and height can be made smaller)

#define CLIP_RECTANGLE_OFS ( x,
y,
width,
height,
ofsx,
ofsy,
endx   ) 

Clip rectangle area (just like CLIP_RECTANGLE), but also return offsets (these offsets can be used to skip data when used for sprites and such)

Todo:
FIXME: not easy to debug, but making it a function needs:
  • pointers to be able to alter given arguments
  • special return value to denote 'outside' clipping region (which is now handled by a simple return in caller function)
Parameters:
x int X screen position
y int Y screen position (return value of X and Y can be made larger)
width int width to display
height int height to display (return value of width and height can be made smaller) returns:
ofsx int offset X from start of sprite data
ofsy int offset Y from start of sprite data
endx int offset to skip the remaining data at the end of each horizontal line of the sprite.
Note:
there was no need for 'endy', as it isn't used to draw sprites..


Variable Documentation

int ClipX1

Profile, frames out of sync.

int ClipX2

current clipping top left

int ClipY1

current clipping top left

int ClipY2

current clipping bottom right

(C) Copyright 1998-2011 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.