Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Holds set of flags and properties define current state of render pipeline.

Namespace: Visual3D.Graphics3D
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

public class PipelineState

Public Class PipelineState

Members


	All Members			Properties			Methods

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	AdapterMonitor	Returns handle of current monitor.
	CheckShouldSkipRenderFrame()()()()	Returns true if in paused mode or IsRenderingRateSlowed is true and no enough time was passed from last frame.
	CurrNumDrawCalls	Returns volatile number of draw calls used during current frame. Valid only for current frame, and will change each time when RenderPipeline.RenderGeometry is called. Use NumDrawCalls for stable stats (from previous frame).
	CurrNumRenderPolygons	Returns volatile number of polygons rendered during current frame. Valid only for current frame, and will change each time when RenderPipeline.RenderGeometry is called. Use NumRenderedPolygons for stable stats (from previous frame).
	FormWindowState	Returns state of the main Form. To change form state, use one of RenderPipeline methods such as MaximizeWindow etc, or use IsMinimized/IsMaximized properties.
	IsCursorClippedWhenFullScreen	Gets/sets flag controlling how mouse cursor is clipped when in full-screen mode.
	IsFailedCreateDevice	Returns true, if there was failure during graphics device creation last time. This flag is reset to false automatically when device is attempted to create again.
	IsForcedLowQualityMode	Gets/sets low-quality render mode: no textures, simple Phong materials with 1 light applied to all scene objects.
	IsFullScreen	Gets/sets full-screen mode flag.
	IsMaximized	Gets/sets flag indicate that render window state is maximized. Also returns true if in full-screen mode.
	IsMinimized	Gets/sets flag indicate that render window state is minimized.
	IsNVPerfHUDMode	Returns true if currently running with NVPerfHUD profiler attached.
	IsOutOfVideoMemory	Returns true if graphics resource operation has caused OutOfVideoMemory exception.
	IsRenderingFrame	Returns true if pipeline is currently in the middle of RenderFrame method call.
	IsRenderingPaused	Gets/sets flag indicate that render pipeline is now paused.
	IsRenderingRateSlowed	Turns on/off fixed 25 FPS mode.
	IsShowingCursorWhenFullScreen	Gets/sets flag controlling mouse cursor visibility in full-screen mode.
	IsWindowed	Gets/sets windowed mode flag.
	IsWindowVisible	Returns true if render output window is visible; false otherwise.
	NumDrawCalls	Returns number of draw calls used to render previous frame. Can be safely used during rendering current frame.
	NumRenderedPolygons	Returns number of polygons rendered during previous frame. Can be safely used during rendering current frame.
	NumShadersToCompile	Returns current number of shaders pending to be compiled in the background thread.
	PreventFocusCaptureOnMouseEnter	Used to prevent automatic focus capture when mouse comes into rendering window, for e.g. label edit in trees etc

Inheritance Hierarchy

System..::..Object
Visual3D.Graphics3D..::..RenderPipeline..::..PipelineState

Syntax

Members

Inheritance Hierarchy

See Also