urho3d.UrhoSharp/Docs/Urho/ApplicationOptions.xml

<Type Name="ApplicationOptions" FullName="Urho.ApplicationOptions">
  <TypeSignature Language="C#" Value="public class ApplicationOptions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ApplicationOptions extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Application options, see full description at:
            http://urho3d.github.io/documentation/1.4/_running.html
            </summary>
    <remarks>
      <para>This contains the list of options that can be configured at application startup, these settings control how the engine is initialized.</para>
      <para></para>
      <para>The options set with this selector are passed to the Urho game engine on startup.</para>
      <para></para>
      <para>You can use the convenience <see cref="T:Urho.ApplicationOptions.Default" /> or <see cref="T:Urho.ApplicationOptions.PortraitDefault" /> static values as options to use as either defaults for landscape or portrait.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ApplicationOptions ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ApplicationOptions (string assetsFolder);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string assetsFolder) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="assetsFolder" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="assetsFolder">This is usually the “Data” directory, but can be null if your application only requires the built-in assets.</param>
        <summary>Initializes the application options with a directory pointing to the assets folders (Usually the “Data” directory)</summary>
        <remarks>Constructs a new instance of <see cref="T:Urho.ApplicationOptions" /></remarks>
      </Docs>
    </Member>
    <Member MemberName="AdditionalFlags">
      <MemberSignature Language="C#" Value="public string AdditionalFlags { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string AdditionalFlags" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Any additional options from the Urho engine that might not be encompassed by one of the strongly typed properties here.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AutoloadCoreData">
      <MemberSignature Language="C#" Value="public bool AutoloadCoreData { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool AutoloadCoreData" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Determines whether the “CoreData” is always part of the resources looked up by Urho.</summary>
        <value>The default value for this property is <see langword="true" />.</value>
        <remarks>By default, the <see cref="T:Urho.ApplicationOptions" /> will set Urho’s internal resource paths to the “CoreData”, plus any directories specified in <see cref="P:Urho.ApplicationOptions.ResourcePaths." />   If you set this flag to <see langword="false" />, then “CoreData” directory will not be included.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DelayedStart">
      <MemberSignature Language="C#" Value="public bool DelayedStart { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool DelayedStart" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>With this option Urho will not start the render loop when Run is called.</summary>
        <value>The state of the delayed start</value>
        <remarks>
          <para>Use this option if you want to prevent the main loop from running immediately.   In that case, you will want to manually run the loop by calling the <see cref="M:Urho.Engine.RunFrame" /> method on a loop at your convenience.</para>
          <para></para>
          <para></para>
          <example>
            <code lang="C#"><![CDATA[var app = new MyApp (new ApplicationOptions () { DelayedStart = true });
while (true){
   app.Engine.RunFrame ();
   // Sleep here.
}
]]></code>
          </example>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ExternalWindow">
      <MemberSignature Language="C#" Value="public IntPtr ExternalWindow { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int ExternalWindow" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Pointer to an NSView or a Win32 handle to use as a surface.</summary>
        <value>The current handle to the native window</value>
        <remarks>
          <para>This is a platform specific pointer to a native handle.   On Windows, this is a handle to a window (HWND), and on Cocoa it is a pointer to an NSView (if you are using the Xamarin.Mac API, this will be the Handle of the <see cref="T:AppKit.NSView" />). </para>
          <para></para>
          <para>This instructs UrhoSharp to use that window or view as its rendering target.   This is used in scenarios where you want to embed the engine into another application.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Height">
      <MemberSignature Language="C#" Value="public int Height { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Height" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Desktop only option.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HighDpi">
      <MemberSignature Language="C#" Value="public bool HighDpi { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool HighDpi" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Enable HighDPI mode (iOS or macOS only). Default value is True.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="LimitFps">
      <MemberSignature Language="C#" Value="public bool LimitFps { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool LimitFps" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Determines whether we should limit the frames (defaults to true), the default is limit is 200 FPS for desktop, and 60 fps, despite of the flag settings.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Multisampling">
      <MemberSignature Language="C#" Value="public int Multisampling { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Multisampling" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Orientation">
      <MemberSignature Language="C#" Value="public Urho.ApplicationOptions.OrientationType Orientation { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.ApplicationOptions/OrientationType Orientation" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.ApplicationOptions+OrientationType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>iOS only - orientation for the game</summary>
        <value>To be added.</value>
        <remarks>This describes the allowed orientation modes for the display.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResizableWindow">
      <MemberSignature Language="C#" Value="public bool ResizableWindow { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool ResizableWindow" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Desktop only - provides a resizable window.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResourcePackagesPaths">
      <MemberSignature Language="C#" Value="public string[] ResourcePackagesPaths { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string[] ResourcePackagesPaths" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Resource package files to use - default empty.</para>
        </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ResourcePaths">
      <MemberSignature Language="C#" Value="public string[] ResourcePaths { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string[] ResourcePaths" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
          <para>Resource path(s) to use (default: Data, CoreData)</para>
        </summary>
        <value>To be added.</value>
        <remarks>
          <para>The <see cref="P:Urho.ApplicationOptions.AutoloadCoreData" /> property controls whether the CoreData directory is included or not.</para>
          <para />
          <para>The paths must be directories, or “.pak” files relative to one of the directories listed in <see cref="P:Urho.ApplicationOptions.ResourcePrefixPaths" />.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ResourcePrefixPaths">
      <MemberSignature Language="C#" Value="public string[] ResourcePrefixPaths { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string[] ResourcePrefixPaths" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Resource prefix path, it defaults to the value of the URHO3D_PREFIX_PATH environment variable, or if not set, the executable path.</summary>
        <value>To be added.</value>
        <remarks>
          <para>Resource paths are relative to the ResourcePrefixPaths.</para>
          <para />
          <para>If using the URHO3D_PREFIX_PATH environment variable, the directories must be separated with a semicolon.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns the command line version suitable to be sent to the Urho engine.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TouchEmulation">
      <MemberSignature Language="C#" Value="public bool TouchEmulation { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool TouchEmulation" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Enable touch-emulation on desktop environments.</summary>
        <value>Defaults to <see langword="false" />.</value>
        <remarks>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Width">
      <MemberSignature Language="C#" Value="public int Width { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Width" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Desktop only option.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="WindowedMode">
      <MemberSignature Language="C#" Value="public bool WindowedMode { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool WindowedMode" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Desktop only option.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>