GraphicsOptions

Remarks

Names and capacities, and nothing about where the passes go — that is the compositor document's, which is the division the whole renderer is built on. What is here is the handful of decisions that join a document to a host: which resource the window is, which view the camera fills, which stage the world draws in, and how much geometry the scene is allowed.

The three names default to the ones DefaultFrame uses, so a project that authors its own compositor either keeps those names or says here what it called them instead. They are strings rather than an enum because a document is authored data: the set of resources in a frame is open, and a host that could only bind names it had compiled in could not run a frame somebody wrote after it shipped.

Fields and properties (25)

• public bool Enabled

  Whether the host opens a device and draws the world at all.

• public IList<ISceneRendererFactory> Factories

  Extra node kinds the frame may name, beyond the ones the builder knows itself.

• public QualityTier Quality

  The scalability tier for a frame that does not name its own.

• public string? Compositor

  The address of the compositor to load, or for the built-in frame.

• public string? Look

  The address of the project's look profile, or for none.

• public string View

  The name of the view the camera fills.

• public string Stage

  The name of the stage the world's drawables are extracted into.

• public IList<string> CasterStages

  Stages an object is extracted into as well as Stage.

• public IList<string> StaticCasterStages

  Which caster stages an entity claiming to be static goes into instead.

• public string ParticleStage

  The name of the stage particle emitters are drawn in, or empty for a frame with none.

• public string Output

  The name of the resource the window's image is lent to the frame as.

• public string? CapturePath

  Where to write the last frame's picture, or for nowhere.

• public string? PipelineCachePath

  Where the driver's own pipeline cache is kept between runs.

• public bool Offscreen

  Whether to open a real device with no surface, and write no picture.

• public IList<GraphicsBackend> Backends

  Which graphics APIs to try, most preferred first.

• public GpuDenyList DenyList

  GPUs and drivers a backend must not be selected on, whatever they claim.

• public PixelFormat Format

  The format to ask the swapchain for.

• public PresentMode PresentMode

  How the swapchain waits for the display.

• public ColorGamut Gamut

  The display gamut to ask the swapchain for.

• public int VertexCapacity

  How many vertices the scene's shared geometry buffer holds.

• public int IndexCapacity

  How many indices it holds.

• public Int2 WindowlessSize

  What size to draw at when there is no window to take a size from.

• public bool GpuProfiling

  Whether each of the frame's passes is timed on the GPU.

• public bool Overlays

  Whether the frame carries the diagnostic overlays, the console and a drawn DebugDraw.

• public IList<string> EnabledOverlays

  Which panels start switched on, by the names overlay <name> uses.

Used by (33)

• AiVillageGameAiVillage
• PbrShowcaseGamePbrShowcase
• ThirdPersonShooterGameThirdPersonShooter
• TriangleGameHelloTriangle
• VideoGameVideoPlayback
• VirtualGeometryGameVirtualGeometry
• AppBuilderVixen.App.Hosting
• AppConfigVixen.App.Hosting
• AppGraphicsVixen.App.Hosting
• IGraphicsBackendVixen.App.Hosting
• VixenApplicationVixen.App.Hosting
• AlwaysHeadlessVixen.App.Tests
• AppArgumentsTestsVixen.App.Tests
• AppBackendTestsVixen.App.Tests
• AuthoredFrameGameVixen.App.Tests
• BackendVixen.App
• CapturingGameVixen.App.Tests
• CountingBackendVixen.App.Tests
• FrameCaptureTestsVixen.App.Tests
• GraphicsHostVixen.App
• GroundGameVixen.App.Tests
• HeadlessVixen.App.Tests
• HostedRendererTestsVixen.App.Tests
• NoGraphicsVixen.App.Tests
• NoGraphicsGameVixen.App.Tests
• PlatformHostVixen.App
• QuietVixen.App.Tests
• SampledGameVixen.App.Tests
• TemplateTestsVixen.Templates.Tests
• TieredGameVixen.App.Tests
• WatcherVixen.App.Tests
• WindowedCapturingGameVixen.App.Tests
• RealmVixen.Live.Realm