public sealed class GraphicsOptionsWhat the host builds the frame out of.
No guide page documents this yet — the page shows what the code says about itself.
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 (14)
public bool EnabledWhether the host opens a device and draws the world at all.
public IList<ISceneRendererFactory> FactoriesExtra node kinds the frame may name, beyond the ones the builder knows itself.
public string? CompositorThe address of the compositor to load, or for the built-in frame.
public string ViewThe name of the view the camera fills.
public string StageThe name of the stage the world's drawables are extracted into.
public IList<string> CasterStagesStages an object is extracted into as well as Stage.
public string ParticleStageThe name of the stage particle emitters are drawn in, or empty for a frame with none.
public string OutputThe name of the resource the window's image is lent to the frame as.
public IList<GraphicsBackend> BackendsWhich graphics APIs to try, most preferred first.
public PixelFormat FormatThe format to ask the swapchain for.
public PresentMode PresentModeHow the swapchain waits for the display.
public int VertexCapacityHow many vertices the scene's shared geometry buffer holds.
public int IndexCapacityHow many indices it holds.
public Int2 WindowlessSizeWhat size to draw at when there is no window to take a size from.
Used by (18)
- PbrShowcaseGamePbrShowcase
- ThirdPersonShooterGameThirdPersonShooter
- TriangleGameHelloTriangle
- VideoGameVideoPlayback
- VirtualGeometryGameVirtualGeometry
- AppBuilderVixen.App.Hosting
- AppConfigVixen.App.Hosting
- AppGraphicsVixen.App.Hosting
- IGraphicsBackendVixen.App.Hosting
- AppBackendTestsVixen.App.Tests
- BackendVixen.App
- CountingBackendVixen.App.Tests
- GraphicsHostVixen.App
- HeadlessVixen.App.Tests
- HostedRendererTestsVixen.App.Tests
- NoGraphicsGameVixen.App.Tests
- PlatformHostVixen.App
- RealmVixen.Live.Realm