intern_video.h File Reference

Go to the source code of this file.

Defines
#define	CLIP_RECTANGLE(x, y, width, height)
#define	CLIP_RECTANGLE_OFS(x, y, width, height, ofsx, ofsy, endx)
Variables
int	ClipX1
	current clipping top left
int	ClipY1
	current clipping top left
int	ClipX2
	current clipping bottom right
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.

Definition in file intern_video.h.

---

Define Documentation

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

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)

Definition at line 93 of file intern_video.h.

Referenced by CGraphic::DrawClip(), CGraphic::DrawFrameClipTransX(), CGraphic::DrawFrameClipX(), linedraw_sdl::DrawHLineClip(), CGraphic::DrawSubClip(), CGraphic::DrawSubClipTrans(), linedraw_sdl::DrawVLineClip(), linedraw_gl::FillRectangleClip(), linedraw_sdl::FillTransRectangleClip(), and VideoDrawOnlyFog().

#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..

Definition at line 148 of file intern_video.h.

Referenced by CGraphic::DoDrawFrameClip(), CGraphic::DoDrawFrameClipX(), and VideoDrawCharClip().

---

Variable Documentation

int ClipX1

current clipping top left

Definition at line 137 of file video.cpp.

Referenced by linedraw_gl::ClipCodeLine(), linedraw_gl::DrawHLineClip(), linedraw_gl::DrawLineClip(), linedraw_gl::DrawRectangleClip(), linedraw_sdl::FillRectangleClip(), PopClipping(), PushClipping(), SetClipping(), linedraw_sdl::VideoDoDrawPixelClip(), and linedraw_sdl::VideoDoDrawTransPixelClip().

int ClipX2

current clipping bottom right

Definition at line 139 of file video.cpp.

Referenced by linedraw_gl::ClipCodeLine(), linedraw_gl::DrawHLineClip(), linedraw_gl::DrawLineClip(), linedraw_gl::DrawPixelClip(), linedraw_gl::DrawRectangleClip(), linedraw_gl::DrawVLineClip(), linedraw_sdl::FillRectangleClip(), PopClipping(), PushClipping(), SetClipping(), linedraw_sdl::VideoDoDrawPixelClip(), and linedraw_sdl::VideoDoDrawTransPixelClip().

int ClipY1

current clipping top left

Definition at line 138 of file video.cpp.

Referenced by linedraw_gl::ClipCodeLine(), linedraw_gl::DrawLineClip(), linedraw_gl::DrawRectangleClip(), linedraw_gl::DrawVLineClip(), linedraw_sdl::FillRectangleClip(), PopClipping(), PushClipping(), SetClipping(), linedraw_sdl::VideoDoDrawPixelClip(), and linedraw_sdl::VideoDoDrawTransPixelClip().

int ClipY2

current clipping bottom right

Definition at line 140 of file video.cpp.

Referenced by linedraw_gl::ClipCodeLine(), linedraw_gl::DrawHLineClip(), linedraw_gl::DrawLineClip(), linedraw_gl::DrawPixelClip(), linedraw_gl::DrawRectangleClip(), linedraw_gl::DrawVLineClip(), linedraw_sdl::FillRectangleClip(), PopClipping(), PushClipping(), SetClipping(), linedraw_sdl::VideoDoDrawPixelClip(), and linedraw_sdl::VideoDoDrawTransPixelClip().