/*
* Copyright (c) 2007-2009 SlimDX Group
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
using System;
using SharpDX.Direct3D9;
namespace SampleFramework
{
///
/// Contains settings for creating a 3D device.
///
public class DeviceSettings : ICloneable
{
///
/// Gets or sets the adapter ordinal.
///
/// The adapter ordinal.
public int AdapterOrdinal
{
get;
set;
}
///
/// Gets or sets the type of the device.
///
/// The type of the device.
public DeviceType DeviceType
{
get;
set;
}
///
/// Gets or sets the refresh rate.
///
/// The refresh rate.
public int RefreshRate
{
get;
set;
}
///
/// Gets or sets the width of the back buffer.
///
/// The width of the back buffer.
public int BackBufferWidth
{
get;
set;
}
///
/// Gets or sets the height of the back buffer.
///
/// The height of the back buffer.
public int BackBufferHeight
{
get;
set;
}
///
/// Gets or sets the back buffer format.
///
/// The back buffer format.
public Format BackBufferFormat
{
get;
set;
}
///
/// Gets or sets the back buffer count.
///
/// The back buffer count.
public int BackBufferCount
{
get;
set;
}
///
/// Gets or sets a value indicating whether the device is windowed.
///
/// true if windowed; otherwise, false.
public bool Windowed
{
get;
set;
}
///
/// Gets or sets a value indicating whether VSync is enabled.
///
/// true if VSync is enabled; otherwise, false.
public bool EnableVSync
{
get;
set;
}
///
/// Gets or sets a value indicating whether this is multithreaded.
///
/// true if multithreaded; otherwise, false.
/// This only has an effect for Direct3D9 devices.
public bool Multithreaded
{
get;
set;
}
///
/// Gets or sets the multisample type.
///
/// The multisample type.
public MultisampleType MultisampleType
{
get;
set;
}
///
/// Gets or sets the multisample quality.
///
/// The multisample quality.
public int MultisampleQuality
{
get;
set;
}
///
/// Gets or sets the depth stencil format.
///
/// The depth stencil format.
public Format DepthStencilFormat
{
get;
set;
}
///
/// Gets or sets the Direct3D9 specific settings.
///
/// The Direct3D9 specific settings.
internal Direct3D9Settings Direct3D9
{
get;
set;
}
///
/// Initializes a new instance of the class.
///
public DeviceSettings()
{
// set sane defaults
DeviceType = DeviceType.Hardware;
BackBufferFormat = Format.Unknown;
BackBufferCount = 1;
MultisampleType = MultisampleType.None;
DepthStencilFormat = Format.Unknown;
Windowed = true;
EnableVSync = true;
}
///
/// Creates a new object that is a copy of the current instance.
///
///
/// A new object that is a copy of this instance.
///
public DeviceSettings Clone()
{
DeviceSettings result = new DeviceSettings();
result.DeviceType = DeviceType;
result.RefreshRate = RefreshRate;
result.BackBufferCount = BackBufferCount;
result.BackBufferFormat = BackBufferFormat;
result.BackBufferHeight = BackBufferHeight;
result.BackBufferWidth = BackBufferWidth;
result.DepthStencilFormat = DepthStencilFormat;
result.MultisampleQuality = MultisampleQuality;
result.MultisampleType = MultisampleType;
result.Windowed = Windowed;
result.EnableVSync = EnableVSync;
result.AdapterOrdinal = AdapterOrdinal;
result.Multithreaded = Multithreaded;
if (Direct3D9 != null)
result.Direct3D9 = Direct3D9.Clone();
return result;
}
///
/// Creates a new object that is a copy of the current instance.
///
///
/// A new object that is a copy of this instance.
///
object ICloneable.Clone()
{
return Clone();
}
///
/// Finds valid device settings based upon the desired settings.
///
/// The desired settings.
/// The best valid device settings matching the input settings.
public static DeviceSettings FindValidSettings( DeviceSettings settings )
{
try
{
GraphicsDeviceManager.EnsureD3D9();
}
catch( Exception e )
{
throw new NoCompatibleDevicesException( "Could not initialize Direct3D9.", e );
}
if( !Enumeration9.HasEnumerated )
Enumeration9.Enumerate();
DeviceSettings newSettings = settings.Clone();
Direct3D9Settings d3d9 = FindValidD3D9Settings( settings );
newSettings.Direct3D9 = d3d9;
return newSettings;
}
static Direct3D9Settings FindValidD3D9Settings(DeviceSettings settings)
{
Direct3D9Settings optimal = Direct3D9Settings.BuildOptimalSettings(settings);
SettingsCombo9 bestCombo = null;
float bestRanking = -1.0f;
foreach (AdapterInfo9 adapterInfo in Enumeration9.Adapters)
{
DisplayMode desktopMode = GraphicsDeviceManager.Direct3D9Object.GetAdapterDisplayMode(adapterInfo.AdapterOrdinal);
foreach (DeviceInfo9 deviceInfo in adapterInfo.Devices)
{
foreach (SettingsCombo9 combo in deviceInfo.DeviceSettings)
{
if (combo.Windowed && combo.AdapterFormat != desktopMode.Format)
continue;
float ranking = Direct3D9Settings.RankSettingsCombo(combo, optimal, desktopMode);
if (ranking > bestRanking)
{
bestCombo = combo;
bestRanking = ranking;
}
}
}
}
if (bestCombo == null)
throw new NoCompatibleDevicesException("No compatible Direct3D9 devices found.");
return Direct3D9Settings.BuildValidSettings(bestCombo, optimal);
}
}
}