Home -> PlatformBindings -> WindowInfoHeadless

Declaration

struct WindowInfoHeadless : public IFrameBuffer::WindowInfoBase;

Description

The WindowInfoHeadless structure describes a window-sized framebuffer target for IFrameBuffer.BindWindow when rendering without a native operating system window.

A framebuffer bound with WindowInfoHeadless behaves like a window framebuffer for tests and server-side rendering workflows, but the renderer creates and owns the underlying offscreen color, depth, and stencil resources rather than presenting through a swap chain or native window surface.

Availability: All platforms. This structure is included unconditionally by PlatformBindings.pkg.

ImportantImportant

Device enumeration should request EnumerationFlags.HeadlessRendering before initializing a renderer with WindowSystemInfoHeadless.

Members

Name Type Description
Public member windowSizeInPixels V2UInt32
The drawable framebuffer size in pixels.

Constructors

Name Description
Public member Constructor
Creates a WindowInfoHeadless structure.

See also