GraphicsParameters

Description

sealed class Tinman.Engine.Rendering.Effects.GraphicsParameters

Derived from

RenderEffectParameters abstract

Render effect parameters for IGraphicsEffect.

The following low-level render effect parameter slots are always defined:

Public / Constants

Changed​Color

public constant ChangedColor → (1 << 0:int32)

Changed flag for Color.

Changed​Colors

public constant ChangedColors → (1 << 1:int32)

Changed flag for Colors.

Changed​Image

public constant ChangedImage → (1 << 2:int32)

Changed flag for Image.

Changed​Image​Mask

public constant ChangedImageMask → (1 << 3:int32)

Changed flag for ImageMask.

Changed​Line

public constant ChangedLine → (1 << 4:int32)

Changed flag for Line.

Changed​Screen​Mask

public constant ChangedScreenMask → (1 << 5:int32)

Changed flag for ScreenMask.

Changed​Screen​Matrix

public constant ChangedScreenMatrix → (1 << 6:int32)

Changed flag for ScreenMatrix.

Changed​Screen​Offset

public constant ChangedScreenOffset → (1 << 7:int32)

Changed flag for ScreenOffset.

Changed​Screen​Size

public constant ChangedScreenSize → (1 << 8:int32)

Changed flag for ScreenSize.

Changed​Slice

public constant ChangedSlice → (1 << 9:int32)

Changed flag for Slice.

Flag​No​Texture​Arrays

public constant FlagNoTextureArrays → (1:int32)

Disable use of texture arrays.

Pass​Default

public constant PassDefault → (0:int32)

The default pass of the render effect.

Pass​Line

public constant PassLine → (1:int32)

The pass for rendering thick lines.

Pass​Point

public constant PassPoint → (2:int32)

The pass for rendering thick points.

Public / Constructors

Graphics​Parameters

public constructor GraphicsParameters → (1)

featureLevel in : LineFeatureLevel

The required feature level.

Creates a new instance of GraphicsParameters.

Public / Attributes

Color

public attribute Color → (get,set)

value : int64

The modulation color.

The modulation color to use for 2D rendering.

Defaults to Colors.White.

Colors

public attribute Colors → (get,set)

value : Vec4I

The color channel sources. The Vec4I.X, Vec4I.Y, Vec4I.Z, Vec4I.W components specify the color source for the red, green, blue and alpha channel output, respectively. The color source values 0, 1, 2, 3, 4, 5, 6 specify the red, green, blue, alpha, all-zero, all-one, luminance input channel, respectively.

The color channel sources to use for 2D rendering.

Defaults to Vec4I.Zero.

Image

public attribute Image → (get,set)

value : ITexture2D

The texture image.

Current texture image.

Defaults to null.

See also

GraphicsParameters.ChangedImage

Image​Mask

public attribute ImageMask → (get,set)

value : ITexture2D

The texture mask.

Current texture image mask.

Defaults to null.

See also

GraphicsParameters.ChangedImageMask

Line

public readonly attribute Line → (LineParameters)

The aggregated line parameters.

See also

GraphicsParameters.ChangedLine

Screen​Mask

public attribute ScreenMask → (get,set)

value : Box2F

The screen bounds.

Current screen bounds of the texture image mask.

Defaults to Box2F.Empty.

Screen​Matrix

public attribute ScreenMatrix → (get,set)

value : Mat2F

The transformation matrix.

Current transformation matrix for screen coordinates.

Defaults to Mat3F.Identity.

See also

GraphicsParameters.ChangedScreenMatrix

Screen​Offset

public attribute ScreenOffset → (get,set)

value : Vec2F

The translation offset.

Current translation offset for screen coordinates, in pixels.

Defaults to Vec2F.Zero.

See also

GraphicsParameters.ChangedScreenOffset

Screen​Size

public attribute ScreenSize → (get,set)

value : Vec2I

The screen size.

Size of the screen, in pixels.

Defaults to Vec2F.Zero.

See also

GraphicsParameters.ChangedScreenSize

Slice

public attribute Slice → (get,set)

value : int32

The texture slice.

Current texture slice.

Defaults to 0.

See also

GraphicsParameters.ChangedSlice