Layer_t Struct Reference
[Render System]

Describes a layer for rendering. More...

#include <render.h>

Collaboration diagram for Layer_t:


Data Fields
union {
struct {
Bool dirty: 1
	Marks a layer as dirty when something on the layer changes or the layer's offset changes and an item on the layer is visible.
}
Uint16 flags
	Bit flags used with layers.
};
Sint16	offX
	The horizontal offset value.
Sint16	offY
	The vertical offset value.
RenderItem *	worldListFirst
	The first item of the list of all items present on the layer.
RenderItem *	worldListLast
	The last item of the list of all items present on the layer.

Detailed Description

Describes a layer for rendering.

Layers provide a Z-ordering for 2D graphics. The ordering of overlapping items in the same layer is not guaranteed. Each layer can be independently offset. Layer coordinates are translated into physical coordinates by adding the offset values.

Todo:: Add a clipping rectangle that affects only owning layer.

Author:: Jeff Jackowski

Definition at line 373 of file render.h.

Field Documentation

union { ... }

Bool Layer_t::dirty

Marks a layer as dirty when something on the layer changes or the layer's offset changes and an item on the layer is visible.

For internal use only.

Definition at line 407 of file render.h.

Uint16 Layer_t::flags

Bit flags used with layers.

Definition at line 400 of file render.h.

Sint16 Layer_t::offX

The horizontal offset value.

Warning:: This value must not change from the time PlaceRenderItem() is called until after the frame has been rendered. Any change must also include setting the dirty flag.

Definition at line 388 of file render.h.

Referenced by PlacePlayerLabel().

Sint16 Layer_t::offY

The vertical offset value.

Warning:: This value must not change from the time PlaceRenderItem() is called until after the frame has been rendered. Any change must also include setting the dirty flag.

Definition at line 395 of file render.h.

Referenced by PlacePlayerLabel().

RenderItem* Layer_t::worldListFirst

The first item of the list of all items present on the layer.

Definition at line 377 of file render.h.

Referenced by AddRenderItem(), and RemoveRenderItem().

RenderItem* Layer_t::worldListLast

The last item of the list of all items present on the layer.

Definition at line 381 of file render.h.

Referenced by AddRenderItem(), and RemoveRenderItem().

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