ImageGear .NET v25.2 - Updated
ImageGear.Processing.Advanced Assembly / ImageGear.Processing Namespace / ImGearEffects Class / SpotlightsPreview Method
Page to apply the effect to.
Page to apply preview of the effect to.
Array of objects specifying spotlight parameters.
Amount to darken the unilluminated area by. Value of 0.0 results in no darkening; value of 1.0 makes unilluminated area black.




In This Topic
    SpotlightsPreview Method
    In This Topic
    This method creates a reduced size preview for the Spotlights effect.
    Syntax
    'Declaration
     
    Public Shared Sub SpotlightsPreview( _
       ByVal page As ImGearRasterPage, _
       ByVal previewPage As ImGearRasterPage, _
       ByVal lights() As ImGearSpotlight, _
       ByVal darkenBy As Double _
    ) 
    'Usage
     
    Dim page As ImGearRasterPage
    Dim previewPage As ImGearRasterPage
    Dim lights() As ImGearSpotlight
    Dim darkenBy As Double
     
    ImGearEffects.SpotlightsPreview(page, previewPage, lights, darkenBy)
    public static void SpotlightsPreview( 
       ImGearRasterPage page,
       ImGearRasterPage previewPage,
       ImGearSpotlight[] lights,
       double darkenBy
    )
    public: static void SpotlightsPreview( 
       ImGearRasterPage* page,
       ImGearRasterPage* previewPage,
       ImGearSpotlight*[]* lights,
       double darkenBy
    ) 
    public:
    static void SpotlightsPreview( 
       ImGearRasterPage^ page,
       ImGearRasterPage^ previewPage,
       array<ImGearSpotlight^>^ lights,
       double darkenBy
    ) 

    Parameters

    page
    Page to apply the effect to.
    previewPage
    Page to apply preview of the effect to.
    lights
    Array of objects specifying spotlight parameters.
    darkenBy
    Amount to darken the unilluminated area by. Value of 0.0 results in no darkening; value of 1.0 makes unilluminated area black.
    Remarks
    This method creates a reduced size preview for the Spotlights method effect. It accepts the same parameters you would use for the full size image, so you don't have to recalculate them to account for the reduced size of the preview.

    The spotlights effect darkens the image and highlights selected areas as if they are illuminated with a spotlight or sunlight.

    See Also