Interface IPlatformNode

Interface for creating new platform nodes for GraphicsTestPlatform. Read-only nodes only need to implement DataType and Current. Activatable nodes (mutable contexts) should extend GlobalContext<TEnum> instead of implementing this interface directly.

Namespace: UnityEngine.TestTools.Graphics

Assembly: UnityEngine.TestTools.Graphics.dll

Syntax

public interface IPlatformNode

Properties

Build

Retrieves the current build platform state at any given time. This will be used to determine which platform state to build for if this node is used.

Declaration

Enum Build { get; }

Property Value

Type	Description
Enum

Current

Retrieves the current platform state at any given time. This will be used to determine the current platform state if this node is used.

Declaration

Enum Current { get; }

Property Value

Type	Description
Enum

DataType

The data type that this node will use. This must be an Enum type.

Declaration

Type DataType { get; }

Property Value

Type	Description
Type

Name

The name of this platform node.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

Activate(Enum)

Activates the given context value. Override in mutable context nodes (via GlobalContext<TEnum>) to change platform state at runtime. Read-only nodes should not override this method.

Declaration

void Activate(Enum value)

Parameters

Type	Name	Description
Enum	value	The enum value to activate.

GetPathSegment(Enum)

The path segment emitted for value when building reference-image paths and bundle names. Defaults to the value's name. Override when a value's name is ambiguous — e.g. aliased enum members sharing one underlying value stringify differently across scripting runtimes — to pin a single canonical segment.

Declaration

string GetPathSegment(Enum value)

Parameters

Type	Name	Description
Enum	value	The enum value to produce a path segment for.

Returns

Type	Description
string	The path segment for value.