Método ID2D1Factory1::RegisterEffectFromString (d2d1_1.h)

  • Artículo

Registra un efecto dentro de la instancia de fábrica con el XML de propiedad especificado como una cadena.

Sintaxis

HRESULT RegisterEffectFromString(
  [in]           REFCLSID                    classId,
  [in]           PCWSTR                      propertyXml,
  [in, optional] const D2D1_PROPERTY_BINDING *bindings,
                 UINT32                      bindingsCount,
                 const PD2D1_EFFECT_FACTORY  effectFactory
);

Parámetros

[in] classId

Tipo: REFCLSID

Identificador del efecto que se va a registrar.

[in] propertyXml

Tipo: PCWSTR

Lista de las propiedades, tipos y metadatos del efecto.

[in, optional] bindings

Tipo: const D2D1_PROPERTY_BINDING*

Matriz de propiedades y métodos.

Esto enlaza una propiedad por nombre a un método determinado implementado por el autor del efecto para controlar la propiedad. El nombre debe encontrarse en la propiedadXml correspondiente.

bindingsCount

Tipo: UINT32

Número de enlaces de la matriz de enlace.

effectFactory

Tipo: PD2D1_EFFECT_FACTORY

Generador estático que se usa para crear el efecto correspondiente.

Valor devuelto

Tipo: HRESULT

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

HRESULT Descripción
S_OK No se ha producido ningún error.
E_OUTOFMEMORY Direct2D no pudo asignar memoria suficiente para completar la llamada.
E_INVALIDARG Se pasó un parámetro no válido a la función de devolución.

Comentarios

Los efectos de Direct2D deben definir sus propiedades en el momento del registro a través del XML de registro. Un efecto declara varias propiedades del sistema necesarias y también puede declarar propiedades personalizadas. Vea Efectos personalizados para obtener más información sobre el formato del parámetro propertyXml .

RegisterEffect es atómico y se cuenta la referencia. Para anular el registro de un efecto, llame a UnregisterEffect con el classId del efecto.

ImportanteRegisterEffect no contiene una referencia al archivo DLL o ejecutable en el que está incluido el efecto. La aplicación debe asegurarse de que la duración del archivo DLL o ejecutable contiene completamente todas las instancias de cada efecto registrado y creado.
 
Además de los efectos integrados registrados globalmente, esta API registra efectos solo para esta fábrica y las interfaces de contexto de dispositivo y dispositivo derivadas.

Requisitos

   
Cliente mínimo compatible Actualización de windows 8 y plataforma para Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2012 y Actualización de plataforma para Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado d2d1_1.h
Library D2d1.lib
Archivo DLL D2d1.dll

Consulte también

ID2D1Factory1

ID2D1Factory1::UnregisterEffect