SlimDXc_Jun2010(VC++2008)/source/directwrite/IFontFileLoader.h

   1 /*\r
   2 * Copyright (c) 2007-2010 SlimDX Group\r
   3 * \r
   4 * Permission is hereby granted, free of charge, to any person obtaining a copy\r
   5 * of this software and associated documentation files (the "Software"), to deal\r
   6 * in the Software without restriction, including without limitation the rights\r
   7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r
   8 * copies of the Software, and to permit persons to whom the Software is\r
   9 * furnished to do so, subject to the following conditions:\r
  10 * \r
  11 * The above copyright notice and this permission notice shall be included in\r
  12 * all copies or substantial portions of the Software.\r
  13 * \r
  14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r
  16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r
  17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r
  18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r
  19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\r
  20 * THE SOFTWARE.\r
  21 */\r
  22 #pragma once\r
  23 \r
  24 #include <dwrite.h>\r
  25 \r
  26 namespace SlimDX\r
  27 {\r
  28         namespace DirectWrite\r
  29         {\r
  30                 ref class FontFileStream;\r
  31 \r
  32                 /// <summary>\r
  33                 /// Font file loader interface handles loading font file resources of a particular type from a key.\r
  34                 /// The font file loader interface is recommended to be implemented by a singleton object.\r
  35                 /// IMPORTANT: font file loader implementations must not register themselves with DirectWrite factory\r
  36                 /// inside their constructors and must not unregister themselves in their destructors, because\r
  37                 /// registration and underregistration operations increment and decrement the object reference count respectively.\r
  38                 /// Instead, registration and underregistration of font file loaders with DirectWrite factory should be performed\r
  39                 /// outside of the font file loader implementation as a separate step.\r
  40                 /// </summary>\r
  41                 public interface struct IFontFileLoader\r
  42                 {\r
  43                         /// <summary>\r
  44                         /// Creates a font file stream object that encapsulates an open file resource.\r
  45                         /// The resource is closed when the last reference to fontFileStream is released.\r
  46                         /// </summary>\r
  47                         /// <param name="fontFileReferenceKey">Font file reference key that uniquely identifies the font file resource\r
  48                         /// within the scope of the font loader being used.</param>\r
  49                         /// <param name="fontFileReferenceKeySize">Size of font file reference key in bytes.</param>\r
  50                         /// <returns>\r
  51                         /// Reference to the newly created font file stream.\r
  52                         /// </returns>\r
  53                         FontFileStream ^CreateStreamFromKey(IntPtr fontFileReferenceKey, int fontFileReferenceKeySize);\r
  54                 };\r
  55 \r
  56                 class IFontFileLoaderShim : public IDWriteFontFileLoader\r
  57                 {\r
  58                 public:\r
  59                         static IFontFileLoaderShim *CreateInstance(IFontFileLoader ^loader);\r
  60 \r
  61                         STDMETHOD(QueryInterface)(REFIID riid, void **ppvObject);\r
  62                         STDMETHOD_(ULONG, AddRef)();\r
  63                         STDMETHOD_(ULONG, Release)();\r
  64 \r
  65                         STDMETHOD(CreateStreamFromKey)(void const *fontFileReferenceKey, UINT32 fontFileReferenceKeySize, IDWriteFontFileStream **fontFileStream);\r
  66 \r
  67                 private:\r
  68                         IFontFileLoaderShim(IFontFileLoader ^wrappedInterface);\r
  69 \r
  70                         int m_refCount;\r
  71                         gcroot<IFontFileLoader ^> m_wrappedInterface;\r
  72                 };\r
  73         }\r
  74 }\r