gstream-set_dirty_rectangle_marker man page



#include <gstream.h>

void set_dirty_rectangle_marker(void (*drm)(int, int, int, int))


Sets a function which the gstream will use to mark the areas that it draws inside as "dirty"; this can, for instance, be very useful in conjuction with a dirty rectangle system in a game where you are using the gstream to output various information during the main loop. The gstream will then automatically be able to inform the system about the parts of the bitmap it has changed so that you don't have to take up that responsibility.

The provided function will be given the parameters: x and y coordinates, and width and height of the rectangle, in that order. So if you're using DRS, you could call this function like this (since that function takes these four parameters x, y, width, height directly):


The marker type function is typedef'ed in the class gbuf, which may come in handy in some situations:

gbuf::dirty_rectangle_marker tmp_drm;


tmp_drm = gs1.get_dirty_rectangle_marker();

Pass the function a null pointer to prevent the gstream from thinking about dirty rectangles, e.g.

set_dirty_rectangle_marker(0);  // or perhaps

If you don't know what the "dirty" principle is all about: well, it is a screen-updating technique similar to double buffering but where you mark the areas that you have drawn on (which made them dirty), and then later when you need to update the screen only blit these areas (thereby cleaning the,) instead of the whole buffer. I suggest you get your hands on DRS if this has made you curious, since it contains an longer introduction to the principle (and also the routines to make it work, by the way :-). It can be fetched at


The default value of the dirty rectangle marker is the null pointer so that the gstream will not bother marking any rectangles.

Note that only the outputter will mark any rectangles dirty, and not the inputter since it is blocking program anyway, waiting for input, meanwhile preventing the main loop from reaching the place where it updates the rectangles.

See Also


Referenced By


Explore man page connections for gstream-set_dirty_rectangle_marker(3).

gstream version 1.6 gstream manual