SlimDXc_Jun2010(VC++2008)/source/directinput/CustomDevice.h

   1 /*
   2 * Copyright (c) 2007-2010 SlimDX Group
   3 *
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy
   5 * of this software and associated documentation files (the "Software"), to deal
   6 * in the Software without restriction, including without limitation the rights
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 * copies of the Software, and to permit persons to whom the Software is
   9 * furnished to do so, subject to the following conditions:
  10 *
  11 * The above copyright notice and this permission notice shall be included in
  12 * all copies or substantial portions of the Software.
  13 *
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 * THE SOFTWARE.
  21 */
  22 #pragma once
  23
  24 #include "DeviceDI.h"
  25
  26 namespace SlimDX
  27 {
  28         namespace DirectInput
  29         {
  30                 generic<typename TDataFormat>
  31                 public ref class CustomDevice : public Device
  32                 {
  33                         COMOBJECT_CUSTOM(IDirectInputDevice8, CustomDevice);
  34
  35                 public:
  36                         /// <summary>
  37                         /// Initializes a new instance of the <see cref="Device"/> class.
  38                         /// </summary>
  39                         /// <param name="subsystem">The subsystem identifier.</param>
  40                         [System::Security::Permissions::SecurityPermission( System::Security::Permissions::SecurityAction::LinkDemand, Flags=System::Security::Permissions::SecurityPermissionFlag::UnmanagedCode )]
  41                         CustomDevice( DirectInput^ directInput, System::Guid subsystem );
  42
  43                         /// <summary>
  44                         /// Retrieves the current device state.
  45                         /// </summary>
  46                         /// <returns>The current device state.</returns>
  47                         TDataFormat GetCurrentState();
  48
  49                         /// <summary>
  50                         /// Retrieves the current device state.
  51                         /// </summary>
  52                         /// <returns>A <see cref="SlimDX::Result"/> object describing the result of the operation.</returns>
  53                         [System::Security::Permissions::SecurityPermission( System::Security::Permissions::SecurityAction::LinkDemand, Flags=System::Security::Permissions::SecurityPermissionFlag::UnmanagedCode )]
  54                         Result GetCurrentState( TDataFormat% data );
  55
  56                         /// <summary>
  57                         /// Retrieves buffered data from the device.
  58                         /// </summary>
  59                         /// <returns>A collection of buffered input events.</returns>
  60                         System::Collections::Generic::IList<TDataFormat>^ GetBufferedData();
  61
  62                         /// <summary>
  63                         /// Gets properties about a single object on an input device.
  64                         /// </summary>
  65                         /// <param name="name">The name of the object whose properties are to be retrieved.</param>
  66                         /// <returns>The properties of the desired object.</returns>
  67                         ObjectProperties^ GetObjectPropertiesByName( System::String^ name );
  68
  69                         DeviceObjectInstance GetObjectInfoByName( System::String^ name );
  70                 };
  71         }
  72 }