SpriteEffect

enum class SRL::Scene2D::SpriteEffect : uint8_t

strong

List of all available sprite effects.

Enumerator
Gouraud	Gouraud shading. Enables/disables gouraud shading for sprites. Expected parameter is zero based index (uint16_t) to a gouraud shading table to enable shading, or negative or no value to disable it. // Disable shading SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Gouraud, -1); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Gouraud); // Enable shading, use 16th entry in the table SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Gouraud, 15);
ScreenDoors	Screen doors effect. Enables/disables screen door effect. Expects boolean value as parameter. // Disable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::ScreenDoors, false); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::ScreenDoors); // Enable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::ScreenDoors, true);
HalfTransparency	Half transparency effect. Enables/disables half transparency effect. Expects boolean value as parameter. // Disable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::HalfTransparency, false); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::HalfTransparency); // Enable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::HalfTransparency, true);
Clipping	Sprite clipping effect. Enables/disables clipping effect. Expects SRL::Scene2D::ClippingEffect enum. Use SRL::Scene2D::SetClippingRectangle() function to set the clipping rectangle. // Disable flip SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Clipping, SRL::Scene2D::ClippingEffect::NoClipping); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Clipping); // Enable flip SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Clipping, SRL::Scene2D::ClippingEffect::ClipInside);
Flip	Flip sprite effect. Allows to set sprite texture read direction (making sprite flipped). // Disable flipping SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Flip, SRL::Scene2D::FlipEffect::NoFlip); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Flip); // Enable clipping SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Flip, SRL::Scene2D::FlipEffect::HorizontalFlip); // Enable flip in both directions SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::Flip, SRL::Scene2D::FlipEffect::HorizontalFlip | SRL::Scene2D::FlipEffect::VerticalFlip);
OpacityBank	VDP2 color calculation effect. Set sprites Color Calculation Ratio to one of 8 stored opacities (Banks 0-7). //Set sprite to use ratio stored in opacity bank 1: SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::OpacityBank, 1); Note Only applies to palette color modes
EnableHSS	Enables textured sprite high speed shrink. When EnableHSS is specified, lines drawn with magnification of less than 1 are drawn by sampling only even or odd pixels of the original data. // Disable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableHSS, false); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableHSS); // Enable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableHSS, true); Note Applies only to textured polygons
EnableECD	Enables end code character for textured sprites. Drawing in horizontal direction is terminated, when an end code is read twice. Color mode EndCode 16 colors (CRAM) 0xf 16 colors (CLUT) 0xf 64 colors (CRAM) 0xff 128 colors (CRAM) 0xff 256 colors (CRAM) 0xff 16bit RGB 0x7fff Behaviour in combination with EnableHSS HSS ECD Behaviour OFF ON End code enabled, drawing in horizontal direction is disabled when second ECD is read and ECD becomes transparent OFF OFF End code disabled, ECD is not processed, color of the code is drawn ON & enlarge ON End code enabled, drawing in horizontal direction is disabled when second ECD is read and ECD becomes transparent ON & reduce ON End code disabled, ECD is not processed, color of the code is drawn ON OFF End code disabled, ECD is not processed, color of the code is drawn // Disable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableECD, false); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableECD); // Enable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::EnableECD, true); Note Applies only to textured polygons
DisablePreClip	Disables pre-clipping of textured sprite. Drawing commands comprise of group of several lines, and perspective lines compris of a number of dots. Each dot is drawn based on drawing area specified by CPU. For lines completely outside or not fully inside drawing area, enabled pre-clipping can improve performance. If lines are fully within drawing area, disabling pre-clipping can improve performance. // Disable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::DisablePreClip, false); // or SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::DisablePreClip); // Enable effect SRL::Scene2D::SetEffect(SRL::Scene2D::SpriteEffect::DisablePreClip, true); Note By default, PreClip is enabled Applies only to textured polygons