SlimDXc_Jun2010(VC++2008)/source/direct3d9/DefaultAllocateHierarchy.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 namespace SlimDX
  25 {
  26         namespace Direct3D9
  27         {
  28                 /// <summary>
  29                 /// Defines a default allocator for frame and mesh container objects.
  30                 /// </summary>
  31                 public ref class DefaultAllocateHierarchy : IAllocateHierarchy
  32                 {
  33                 private:
  34                         static DefaultAllocateHierarchy^ allocator;
  35
  36                 public:
  37                         /// <summary>
  38                         /// Initializes a new instance of the <see cref="DefaultAllocateHierarchy"/> class.
  39                         /// </summary>
  40                         DefaultAllocateHierarchy();
  41
  42                         /// <summary>
  43                         /// Gets a global instance of the default allocator.
  44                         /// </summary>
  45                         static property DefaultAllocateHierarchy^ DefaultAllocator { DefaultAllocateHierarchy^ get(); }
  46
  47                         /// <summary>
  48                         /// Requests the allocation of a mesh container object.
  49                         /// </summary>
  50                         /// <param name="name">Name of the mesh.</param>
  51                         /// <param name="meshData">The actual mesh data.</param>
  52                         /// <param name="materials">Set of materials used in the mesh.</param>
  53                         /// <param name="effectInstances">Set of effects used in the mesh.</param>
  54                         /// <param name="adjacency">Adjancey array used in the mesh.</param>
  55                         /// <param name="skinInfo">Skin mesh object containing skin data.</param>
  56                         /// <returns>The created mesh container.</returns>
  57                         virtual MeshContainer^ CreateMeshContainer( System::String^ name, MeshData^ meshData, array<ExtendedMaterial>^ materials, array<EffectInstance>^ effectInstances, array<int>^ adjacency, SkinInfo^ skinInfo );
  58
  59                         /// <summary>
  60                         /// Requests the allocation of a frame object.
  61                         /// </summary>
  62                         /// <param name="name">Name of the frame to be created.</param>
  63                         /// <returns>The created frame object.</returns>
  64                         virtual Frame^ CreateFrame( System::String^ name );
  65
  66                         /// <summary>
  67                         /// Requests deallocation of a frame object.
  68                         /// </summary>
  69                         /// <param name="frame">The frame to be deallocated.</param>
  70                         virtual void DestroyFrame( Frame^ frame );
  71
  72                         /// <summary>
  73                         /// Requests deallocation of a mesh container object.
  74                         /// </summary>
  75                         /// <param name="container">The mesh container to be deallocated.</param>
  76                         virtual void DestroyMeshContainer( MeshContainer^ container );
  77                 };
  78         }
  79 }