GrapeCity.Documents

GrapeCity.Documents.DX.Direct2D.Effect

Class Effect

Namespace: GrapeCity.Documents.DX.Direct2D

Assembly: GcDocs.DX.Windows.dll

ID2D1Effect

[Guid("28211a43-7d89-476f-8181-2d6159b220ad")]
public class Effect : Properties, IDisposable, IUnknown

Inheritance: object

DisposeBase

CppObject

ComObject

Properties

Effect

Implements: System.IDisposable

IUnknown

Inherited Members: Properties.GetPropertyName(int)

Properties.GetIntValue(int)

Properties.GetUIntValue(int)

Properties.GetFloatValue(int)

Properties.GetBoolValue(int)

Properties.GetGuidValue(int)

Properties.GetVector2Value(int)

Properties.GetVector3Value(int)

Properties.GetVector4Value(int)

Properties.GetPoint2FValue(int)

Properties.GetRectFValue(int)

Properties.GetColorFValue(int)

Properties.GetMatrix3x2Value(int)

Properties.GetMatrix4x4Value(int)

Properties.GetMatrix5x4Value(int)

Properties.GetEnumValue<T>(int)

Properties.GetComObjectValue<T>(int)

Properties.GetValue<T>(int, PropertyType)

Properties.GetIntValueByName(string)

Properties.GetUIntValueByName(string)

Properties.GetFloatValueByName(string)

Properties.GetBoolValueByName(string)

Properties.GetGuidValueByName(string)

Properties.GetVector2ValueByName(string)

Properties.GetVector3ValueByName(string)

Properties.GetVector4ValueByName(string)

Properties.GetPoint2FValueByName(string)

Properties.GetRectFValueByName(string)

Properties.GetColorFValueByName(string)

Properties.GetMatrix3x2ValueByName(string)

Properties.GetMatrix4x4ValueByName(string)

Properties.GetMatrix5x4ValueByName(string)

Properties.GetEnumValueByName<T>(string)

Properties.GetComObjectValueByName<T>(string)

Properties.GetValue<T>(string, PropertyType)

Properties.SetValueByName(string, int)

Properties.SetValueByName(string, uint)

Properties.SetValueByName(string, bool)

Properties.SetValueByName(string, Guid)

Properties.SetValueByName(string, float)

Properties.SetValueByName(string, Vector2)

Properties.SetValueByName(string, Vector3)

Properties.SetValueByName(string, Vector4)

Properties.SetValueByName(string, Point2F)

Properties.SetValueByName(string, RectF)

Properties.SetValueByName(string, ColorF)

Properties.SetValueByName(string, Matrix3x2)

Properties.SetValueByName(string, Matrix4x4)

Properties.SetValueByName(string, Matrix5x4)

Properties.SetValueByName(string, string)

Properties.SetValueByName<T>(string, T)

Properties.SetValueByName<T>(string, PropertyType, T)

Properties.SetValue(int, int)

Properties.SetValue(int, uint)

Properties.SetValue(int, bool)

Properties.SetValue(int, Guid)

Properties.SetValue(int, float)

Properties.SetValue(int, Vector2)

Properties.SetValue(int, Vector3)

Properties.SetValue(int, Vector4)

Properties.SetValue(int, Point2F)

Properties.SetValue(int, RectF)

Properties.SetValue(int, ColorF)

Properties.SetValue(int, Matrix3x2)

Properties.SetValue(int, Matrix4x4)

Properties.SetValue(int, Matrix5x4)

Properties.SetValue(int, string)

Properties.SetEnumValue<T>(int, T)

Properties.SetValue<T>(int, T)

Properties.SetValue<T>(int, PropertyType, T)

Properties.GetPropertyCount()

Properties.GetPropertyName(int, IntPtr, int)

Properties.GetPropertyNameLength(int)

Properties.GetTypeInfo(int)

Properties.GetPropertyIndex(string)

Properties.SetValueByName(string, PropertyType, IntPtr, int)

Properties.SetValue(int, PropertyType, IntPtr, int)

Properties.GetValueByName(string, PropertyType, IntPtr, int)

Properties.GetValue(int, PropertyType, IntPtr, int)

Properties.GetValueSize(int)

Properties.GetSubProperties(int)

Properties.Cached

ComObject.QueryInterface(Guid, out IntPtr)

ComObject.QueryInterfaceOrNull(Guid)

ComObject.EqualsComObject<T>(T, T)

ComObject.QueryInterface<T>()

ComObject.As<T>(object)

ComObject.As<T>(IntPtr)

ComObject.QueryInterface<T>(object)

ComObject.QueryInterfaceOrNull<T>(IntPtr)

ComObject.QueryInterfaceOrNull<T>()

ComObject.QueryInterfaceFrom<T>(T)

ComObject.NativePointerUpdating()

ComObject.NativePointerUpdated(IntPtr)

CppObject.FromTemp(CppObject)

CppObject.FromTemp(IntPtr)

CppObject.FromPointer<T>(IntPtr)

CppObject.ToCallbackPtr<TCallback>(ICallbackable)

CppObject.Tag

CppObject.NativePointer

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.Disposing

DisposeBase.Disposed

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

Effect(IntPtr)

Initializes a new instance of the Effect class.

public Effect(IntPtr nativePtr)

Parameters

nativePtr System.IntPtr: The native pointer.

Fields

AffineTransform2D

CLSID_D2D12DAffineTransform

public static readonly Guid AffineTransform2D

Field Value

System.Guid

ArithmeticComposite

CLSID_D2D1ArithmeticComposite

public static readonly Guid ArithmeticComposite

Field Value

System.Guid

Atlas

CLSID_D2D1Atlas

public static readonly Guid Atlas

Field Value

System.Guid

BitmapSource

CLSID_D2D1BitmapSource

public static readonly Guid BitmapSource

Field Value

System.Guid

Blend

CLSID_D2D1Blend

public static readonly Guid Blend

Field Value

System.Guid

Border

CLSID_D2D1Border

public static readonly Guid Border

Field Value

System.Guid

Brightness

CLSID_D2D1Brightness

public static readonly Guid Brightness

Field Value

System.Guid

ColorManagement

CLSID_D2D1ColorManagement

public static readonly Guid ColorManagement

Field Value

System.Guid

ColorMatrix

CLSID_D2D1ColorMatrix

public static readonly Guid ColorMatrix

Field Value

System.Guid

Composite

CLSID_D2D1Composite

public static readonly Guid Composite

Field Value

System.Guid

ConvolveMatrix

CLSID_D2D1ConvolveMatrix

public static readonly Guid ConvolveMatrix

Field Value

System.Guid

Crop

CLSID_D2D1Crop

public static readonly Guid Crop

Field Value

System.Guid

DirectionalBlur

CLSID_D2D1DirectionalBlur

public static readonly Guid DirectionalBlur

Field Value

System.Guid

DiscreteTransfer

CLSID_D2D1DiscreteTransfer

public static readonly Guid DiscreteTransfer

Field Value

System.Guid

DisplacementMap

CLSID_D2D1DisplacementMap

public static readonly Guid DisplacementMap

Field Value

System.Guid

DistantDiffuse

CLSID_D2D1DistantDiffuse

public static readonly Guid DistantDiffuse

Field Value

System.Guid

DistantSpecular

CLSID_D2D1DistantSpecular

public static readonly Guid DistantSpecular

Field Value

System.Guid

DpiCompensation

CLSID_D2D1DpiCompensation

public static readonly Guid DpiCompensation

Field Value

System.Guid

Flood

CLSID_D2D1Flood

public static readonly Guid Flood

Field Value

System.Guid

GammaTransfer

CLSID_D2D1GammaTransfer

public static readonly Guid GammaTransfer

Field Value

System.Guid

GaussianBlur

CLSID_D2D1GaussianBlur

public static readonly Guid GaussianBlur

Field Value

System.Guid

Histogram

CLSID_D2D1Histogram

public static readonly Guid Histogram

Field Value

System.Guid

HueRotation

CLSID_D2D1HueRotation

public static readonly Guid HueRotation

Field Value

System.Guid

LinearTransfer

CLSID_D2D1LinearTransfer

public static readonly Guid LinearTransfer

Field Value

System.Guid

LuminanceToAlpha

CLSID_D2D1LuminanceToAlpha

public static readonly Guid LuminanceToAlpha

Field Value

System.Guid

Morphology

CLSID_D2D1Morphology

public static readonly Guid Morphology

Field Value

System.Guid

OpacityMetadata

CLSID_D2D1OpacityMetadata

public static readonly Guid OpacityMetadata

Field Value

System.Guid

PerspectiveTransform3D

CLSID_D2D13DPerspectiveTransform

public static readonly Guid PerspectiveTransform3D

Field Value

System.Guid

PointDiffuse

CLSID_D2D1PointDiffuse

public static readonly Guid PointDiffuse

Field Value

System.Guid

PointSpecular

CLSID_D2D1PointSpecular

public static readonly Guid PointSpecular

Field Value

System.Guid

Premultiply

CLSID_D2D1Premultiply

public static readonly Guid Premultiply

Field Value

System.Guid

Saturation

CLSID_D2D1Saturation

public static readonly Guid Saturation

Field Value

System.Guid

Scale

CLSID_D2D1Scale

public static readonly Guid Scale

Field Value

System.Guid

Shadow

CLSID_D2D1Shadow

public static readonly Guid Shadow

Field Value

System.Guid

SpotDiffuse

CLSID_D2D1SpotDiffuse

public static readonly Guid SpotDiffuse

Field Value

System.Guid

SpotSpecular

CLSID_D2D1SpotSpecular

public static readonly Guid SpotSpecular

Field Value

System.Guid

TableTransfer

CLSID_D2D1TableTransfer

public static readonly Guid TableTransfer

Field Value

System.Guid

Tile

CLSID_D2D1Tile

public static readonly Guid Tile

Field Value

System.Guid

Transform3D

CLSID_D2D13DTransform

public static readonly Guid Transform3D

Field Value

System.Guid

Turbulence

CLSID_D2D1Turbulence

public static readonly Guid Turbulence

Field Value

System.Guid

UnPremultiply

CLSID_D2D1UnPremultiply

public static readonly Guid UnPremultiply

Field Value

System.Guid

YCbCr

CLSID_D2D1YCbCr

public static readonly Guid YCbCr

Field Value

System.Guid

Properties

CustomEffect

Gets or sets the associated instance of ICustomEffect.

public ICustomEffect CustomEffect { get; set; }

Property Value

ICustomEffect

Methods

Create(DeviceContext, Guid)

Initializes a new instance of the Effect class.

public static Effect Create(DeviceContext deviceContext, Guid effectId)

Parameters

deviceContext DeviceContext: The device context.
effectId System.Guid: The class ID of the effect to create.

Returns

Effect

Remarks

The created effect does not increment the reference count for the dynamic-link library (DLL) from which the effect was created. If the application deletes an effect while that effect is loaded, the resulting behavior will be unpredictable.

Create(EffectContext, Guid)

Initializes a new instance of the Effect class.

public static Effect Create(EffectContext effectContext, Guid effectId)

Parameters

effectContext EffectContext: The effect context.
effectId System.Guid: The class ID of the effect to create.

Returns

Effect

CreateCustom<T>(DeviceContext)

Initializes a new instance of a custom Effect class.

public static Effect CreateCustom<T>(DeviceContext deviceContext) where T : ICustomEffect

Parameters

deviceContext DeviceContext: The device context.

Returns

Effect

Type Parameters

T

CreateCustom<T>(EffectContext)

Initializes a new instance of a custom Effect class.

public static Effect CreateCustom<T>(EffectContext effectContext) where T : ICustomEffect

Parameters

effectContext EffectContext: The effect context.

Returns

Effect

Type Parameters

T

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

GetInput(int)

void ID2D1Effect::GetInput([In] unsigned int index,[Out, Optional] ID2D1Image** input)

public Image GetInput(int index)

Parameters

index int

Returns

Image

GetInputCount()

unsigned int ID2D1Effect::GetInputCount()

public int GetInputCount()

Returns

int

GetOutput()

void ID2D1Effect::GetOutput([Out] ID2D1Image** outputImage)

public Image GetOutput()

Returns

Image

RegisterAndCreateCustom<T>(Factory1, DeviceContext)

Registers, if necessary, and initializes a new instance of a custom Effect class.

public static Effect RegisterAndCreateCustom<T>(Factory1 factory, DeviceContext deviceContext) where T : ICustomEffect, new()

Parameters

factory Factory1: The factory to register the effect.
deviceContext DeviceContext: The device context.

Returns

Effect

Type Parameters

T

SetInput(int, Image, bool)

void ID2D1Effect::SetInput([In] unsigned int index,[In, Optional] ID2D1Image* input,[In] BOOL invalidate)

public void SetInput(int index, Image input, bool invalidate = true)

Parameters

index int
input Image
invalidate bool

SetInputCount(int)

HRESULT ID2D1Effect::SetInputCount([In] unsigned int inputCount)

public void SetInputCount(int inputCount)

Parameters

inputCount int

SetInputEffect(int, Effect, bool)

Sets the input by using the output of a given effect.

public void SetInputEffect(int index, Effect effect, bool invalidate = true)

Parameters

index int: Index of the input
effect Effect: Effect output to use as input
invalidate bool: To invalidate

Operators

explicit operator Effect(IntPtr)

Performs an explicit conversion from System.IntPtr to Effect.

public static explicit operator Effect(IntPtr nativePointer)

Parameters

nativePointer System.IntPtr

Returns

Effect