SpriteEffect Class


SpriteEffect Class

SpriteEffect is a base abstract class that can render 2D sprites to the scene.

Inheritance Hierarchy

Namespace: Ab3d.DirectX.Effects
Assembly: Ab3d.DXEngine (in Ab3d.DXEngine.dll) Version: 7.1.9105.2048 (1.0.0.0)

Syntax

public abstract class SpriteEffect : SharedDXDeviceResource

The SpriteEffect type exposes the following members.

Properties

	Name	Description
	LastUsedFrameNumber	Gets the frame number when the ApplyPerFrameSettings was last called.
	RequiredInputLayoutType	Gets the input layout that is required to render this effect.

Methods

	Name	Description
	ApplyBatchStates	Applies the shader states that are used to render one sprite batch
	ApplyBatchTransform	Applies the transformation setting that are used to render one sprite batch
	ApplyPerFrameSettings	Sets per frame settings for this effect (this sets camera, lights and other per frame settings).
	ApplyTextureSetting	Applies the setting that are used to sprites with the same texture
	PreloadShaders	PreloadShaders can be called to load the shaders in advance before they are used. Calling this method increases the startup time, but when the 3D object needs to be shown, it is shown faster because all the shaders have already been created.
	ResetLastUsedFrameNumber	ResetLastUsedFrameNumber sets LastUsedFrameNumber to -1. This is used to prevent calling ApplyPerFrameSettings when this effect is used multiple times with different lights on one frame.