Document Solutions for PDF
DS.Documents.DX.Windows Assembly / GrapeCity.Documents.DX.Direct2D.Effects Namespace / SpotDiffuse Class
Properties Methods Events

In This Topic
    SpotDiffuse Class Members
    In This Topic

    The following tables list the members exposed by SpotDiffuse.

    Public Constructors
     NameDescription
    Public ConstructorSpotDiffuse ConstructorInitializes a new instance of the SpotDiffuse class.  
    Top
    Public Properties
     NameDescription
    Public PropertyCachedGets or sets Cached property. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public PropertyColorThe color of the incoming light. This property is exposed as a GrapeCity.Documents.DX.Vector3 – (R, G, B) and used to compute LR, LG, LB.  
    Public PropertyCustomEffectGets or sets the associated instance of GrapeCity.Documents.DX.Direct2D.ICustomEffect. (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public PropertyDiffuseConstantThe ratio of diffuse reflection to amount of incoming light. This property must be between 0 and 10,000 and is unitless.  
    Public PropertyFocusThe focus of the spot light. This property is unitless and is defined between 0 and 200.  
    Public PropertyIsDisposedGets a value indicating whether this instance is disposed. (Inherited from GrapeCity.Documents.DX.DisposeBase)
    Public PropertyKernelUnitLengthThe size of an element in the Sobel kernel used to generate the surface normal in the X and Y direction. This property maps to the dx and dy values in the Sobel gradient. This property is a GrapeCity.Documents.DX.Vector2 (Kernel Unit Length X, Kernel Unit Length Y) and is defined in (device-independent pixels (DIPs)/Kernel Unit). The effect uses bilinear interpolation to scale the bitmap to match size of kernel elements.  
    Public PropertyLightPositionThe light position of the point light source. The property is a GrapeCity.Documents.DX.Vector3 defined as (x, y, z). The units are in device-independent pixels (DIPs) and the values are unitless and unbounded.  
    Public PropertyLimitingConeAngleThe cone angle that restricts the region where the light is projected. No light is projected outside the cone. The limiting cone angle is the angle between the spot light axis (the axis between the LightPosition and PointsAt properties) and the spot light cone. This property is defined in degrees and must be between 0 to 90 degrees.  
    Public PropertyNativePointerGet a pointer to the underlying Cpp Object (Inherited from GrapeCity.Documents.DX.CppObject)
    Public PropertyPointsAtWhere the spot light is focused. The property is exposed as a GrapeCity.Documents.DX.Vector3 with – (x, y, z). The units are in DIPs and the values are unbounded.  
    Public PropertyScaleModeThe interpolation mode the effect uses to scale the image to the corresponding kernel unit length. There are six scale modes that range in quality and speed. If you don't select a mode, the effect uses the interpolation mode of the device context. See Scale modes for more info.  
    Public PropertySurfaceScaleThe scale factor in the Z direction. The value is unitless and must be between 0 and 10,000.  
    Public PropertyTagGets or sets a custom user tag object to associate with this instance.. (Inherited from GrapeCity.Documents.DX.CppObject)
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)CreateInitializes a new instance of SpotDiffuse effect.  
    Public MethodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from GrapeCity.Documents.DX.DisposeBase)
    Public MethodGetBoolValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetBoolValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetColorFValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetColorFValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetComObjectValue<T>Gets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetComObjectValueByName<T>Gets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetEnumValue<T>Gets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetEnumValueByName<T>Gets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetFloatValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetFloatValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetGuidValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetGuidValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetInputvoid ID2D1Effect::GetInput([In] unsigned int index,[Out, Optional] ID2D1Image** input) (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodGetInputCountunsigned int ID2D1Effect::GetInputCount() (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodGetIntValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetIntValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix3x2ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix3x2ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix4x4ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix4x4ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix5x4ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetMatrix5x4ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetOutputvoid ID2D1Effect::GetOutput([Out] ID2D1Image** outputImage) (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodGetPoint2FValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetPoint2FValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetPropertyCountunsigned int ID2D1Properties::GetPropertyCount() (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetPropertyIndexunsigned int ID2D1Properties::GetPropertyIndex([In] const wchar_t* name) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetPropertyNameOverloaded. Gets the number of characters for the given property name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetPropertyNameLengthunsigned int ID2D1Properties::GetPropertyNameLength([In] unsigned int index) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetRectFValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetRectFValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetSubPropertiesHRESULT ID2D1Properties::GetSubProperties([In] unsigned int index,[Out, Optional] ID2D1Properties** subProperties) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetTypeInfoD2D1_PROPERTY_TYPE ID2D1Properties::GetType([In] unsigned int index) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetUIntValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetUIntValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetValueOverloaded. Gets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetValueByNameHRESULT ID2D1Properties::GetValueByName([In] const wchar_t* name,[In] D2D1_PROPERTY_TYPE type,[Out, Buffer] void* data,[In] unsigned int dataSize) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetValueSizeunsigned int ID2D1Properties::GetValueSize([In] unsigned int index) (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector2ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector2ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector3ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector3ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector4ValueGets the value of the specified property by index. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodGetVector4ValueByNameGets the value of the specified property by name. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodQueryInterfaceOverloaded. Query this instance for a particular COM GUID/interface support. (Inherited from GrapeCity.Documents.DX.ComObject)
    Public MethodQueryInterfaceOrNullOverloaded. Query instance for a particular COM GUID/interface support. (Inherited from GrapeCity.Documents.DX.ComObject)
    Public MethodSetEnumValue<T>Sets the named property to the given value. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodSetInputvoid ID2D1Effect::SetInput([In] unsigned int index,[In, Optional] ID2D1Image* input,[In] BOOL invalidate) (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodSetInputCountHRESULT ID2D1Effect::SetInputCount([In] unsigned int inputCount) (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodSetInputEffectSets the input by using the output of a given effect. (Inherited from GrapeCity.Documents.DX.Direct2D.Effect)
    Public MethodSetValueOverloaded. Sets the named property to the given value. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Public MethodSetValueByNameOverloaded. Sets the named property to the given value. (Inherited from GrapeCity.Documents.DX.Direct2D.Properties)
    Top
    Public Events
     NameDescription
    Public EventDisposedOccurs when this instance is fully disposed. (Inherited from GrapeCity.Documents.DX.DisposeBase)
    Public EventDisposingOccurs when this instance is starting to be disposed. (Inherited from GrapeCity.Documents.DX.DisposeBase)
    Top
    See Also

    Reference

    SpotDiffuse Class
    GrapeCity.Documents.DX.Direct2D.Effects Namespace