Vixen
02b45cc4
csharp
public static class Lights

Reading and writing an entity's light, and what the kinds are called.

No guide page documents this yet — the page shows what the code says about itself.

Fields and properties (1)

  • public static IReadOnlyList<LightKind> All

    Every kind, in the order a menu should offer them.

Methods (7)

  • public static string NameOf(LightKind kind)

    What a kind is called in a scene file and in a command id.

  • public static string TitleOf(LightKind kind)

    What a kind is called in a menu.

  • public static bool TryParse(string? text, out LightKind kind)

    Reads a kind's name back, tolerating one that is not a kind.

  • public static Light Default(LightKind kind)

    A light of a kind, with values that light something.

  • public static void Attach(World world, Entity entity, Light light)

    Gives an entity a light, or replaces the one it has.

  • public static void Attach(World world, Entity entity, LightKind kind)

    Gives an entity a light of a kind, with that kind's defaults.

  • public static bool TryGet(World world, Entity entity, out Light light)

    What light an entity is, if it is one.

Used by (12)

  • LightExtractionTestsVixen.Rendering.Tests
  • ComponentsViewVixen.Editor.App
  • CreateMenuTestsVixen.Editor.App.Tests
  • EditorAffordanceTestsVixen.Editor.App.Tests
  • EditorApplicationVixen.Editor.App
  • IconContributionTestsVixen.Editor.App.Tests
  • LightTestsVixen.Editor.SceneView.Tests
  • SceneDocumentVixen.Editor.SceneView
  • SceneFormatMigrationTestsVixen.Editor.SceneView.Tests
  • SceneLinesVixen.Editor.SceneView
  • SceneRenderComponentTestsVixen.Editor.Assets.Tests
  • SceneSerializerVixen.Editor.SceneView