SlimDXc_Jun2010(VC++2008)/source/directwrite/IFontFileLoader.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 <dwrite.h>
  25
  26 namespace SlimDX
  27 {
  28         namespace DirectWrite
  29         {
  30                 ref class FontFileStream;
  31
  32                 /// <summary>
  33                 /// Font file loader interface handles loading font file resources of a particular type from a key.
  34                 /// The font file loader interface is recommended to be implemented by a singleton object.
  35                 /// IMPORTANT: font file loader implementations must not register themselves with DirectWrite factory
  36                 /// inside their constructors and must not unregister themselves in their destructors, because
  37                 /// registration and underregistration operations increment and decrement the object reference count respectively.
  38                 /// Instead, registration and underregistration of font file loaders with DirectWrite factory should be performed
  39                 /// outside of the font file loader implementation as a separate step.
  40                 /// </summary>
  41                 public interface struct IFontFileLoader
  42                 {
  43                         /// <summary>
  44                         /// Creates a font file stream object that encapsulates an open file resource.
  45                         /// The resource is closed when the last reference to fontFileStream is released.
  46                         /// </summary>
  47                         /// <param name="fontFileReferenceKey">Font file reference key that uniquely identifies the font file resource
  48                         /// within the scope of the font loader being used.</param>
  49                         /// <param name="fontFileReferenceKeySize">Size of font file reference key in bytes.</param>
  50                         /// <returns>
  51                         /// Reference to the newly created font file stream.
  52                         /// </returns>
  53                         FontFileStream ^CreateStreamFromKey(IntPtr fontFileReferenceKey, int fontFileReferenceKeySize);
  54                 };
  55
  56                 class IFontFileLoaderShim : public IDWriteFontFileLoader
  57                 {
  58                 public:
  59                         static IFontFileLoaderShim *CreateInstance(IFontFileLoader ^loader);
  60
  61                         STDMETHOD(QueryInterface)(REFIID riid, void **ppvObject);
  62                         STDMETHOD_(ULONG, AddRef)();
  63                         STDMETHOD_(ULONG, Release)();
  64
  65                         STDMETHOD(CreateStreamFromKey)(void const *fontFileReferenceKey, UINT32 fontFileReferenceKeySize, IDWriteFontFileStream **fontFileStream);
  66
  67                 private:
  68                         IFontFileLoaderShim(IFontFileLoader ^wrappedInterface);
  69
  70                         int m_refCount;
  71                         gcroot<IFontFileLoader ^> m_wrappedInterface;
  72                 };
  73         }
  74 }