Actions

Difference between revisions of "GFL Filters"

From XnView Wiki

(Created page with '== gflAverage == == gflSoften == == gflBlur == == gflGaussianBlur == == gflMaximum == == gflMinimum == == gflMedianBox == == gflMedianCross == == gflSharpen == == gflEnhanceDetai…')
 
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== gflAverage ==
== gflAverage ==
The gflAverage function :
GFL_ERROR <b>gflAverage</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflSoften ==
== gflSoften ==
The gflSoften function :
GFL_ERROR <b>gflSoften</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 percentage
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:percentage
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflBlur ==
== gflBlur ==
The gflBlur function :
GFL_ERROR <b>gflBlur</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 percentage
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:percentage
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflGaussianBlur ==
== gflGaussianBlur ==
The gflGaussianBlur function :
GFL_ERROR <b>gflGaussianBlur</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflMaximum ==
== gflMaximum ==
The gflMaximum function :
GFL_ERROR <b>gflMaximum</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflMinimum ==
== gflMinimum ==
The gflMinimum function :
GFL_ERROR <b>gflMinimum</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflMedianBox ==
== gflMedianBox ==
The gflMedianBox function :
GFL_ERROR <b>gflMedianBox</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflMedianCross ==
== gflMedianCross ==
The gflMedianCross function :
GFL_ERROR <b>gflMedianCross</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 filter_size
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:filter_size
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflSharpen ==
== gflSharpen ==
The gflSharpen function :
GFL_ERROR <b>gflSharpen</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  GFL_INT32 percentage
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
:percentage
::To do.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEnhanceDetail ==
== gflEnhanceDetail ==
The gflEnhanceDetail function :
GFL_ERROR <b>gflEnhanceDetail</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEnhanceFocus ==
== gflEnhanceFocus ==
The gflEnhanceFocus function :
GFL_ERROR <b>gflEnhanceFocus</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflFocusRestoration ==
== gflFocusRestoration ==
The gflFocusRestoration function :
GFL_ERROR <b>gflFocusRestoration</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEdgeDetectLight ==
== gflEdgeDetectLight ==
The gflEdgeDetectLight function :
GFL_ERROR <b>gflEdgeDetectLight</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEdgeDetectMedium ==
== gflEdgeDetectMedium ==
The gflEdgeDetectMedium function :
GFL_ERROR <b>gflEdgeDetectMedium</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEdgeDetectHeavy ==
== gflEdgeDetectHeavy ==
The gflEdgeDetectHeavy function :
GFL_ERROR <b>gflEdgeDetectHeavy</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEmboss ==
== gflEmboss ==
The gflEmboss function :
GFL_ERROR <b>gflEmboss</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflEmbossMore ==
== gflEmbossMore ==
The gflEmbossMore function :
GFL_ERROR <b>gflEmbossMore</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst
);
'''Parameters'''
:src
::Pointer to a GFL_BITMAP structure.
:dst
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].
== gflConvolve ==
== gflConvolve ==


The gflConvolve function applies a convolution matrix on a picture.  
The gflConvolve function applies a convolution matrix on a picture.  


GFL_ERROR <b>gflConvolve</b>(
  GFL_BITMAP* src, 
  GFL_BITMAP** dst, 
  const GFL_FILTER* filter
);


GFL_ERROR gflConvolve(
'''Parameters'''
  GFL_BITMAP * src, 
  GFL_BITMAP ** dst, 
  const GFL_FILTER * filter
);
 
Parameters  


src  
:src  
Pointer to a GFL_BITMAP structure.  
::Pointer to a GFL_BITMAP structure.  
dst  
:dst  
Address of a pointer to a GFL_BITMAP structure.  
::Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.  
NULL if on the same instance.  
:filter  
filter  
::Pointer to a [[Structures#GFL_FILTER|GFL_FILTER]] structure.  
Pointer to a GFL_FILTER structure.  


Return value  
'''Return value'''
:The function returns GFL_NO_ERROR if it is successful or a value of [[Error|GFL_ERROR]].


The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.
[[Category: GFLSDK Reference Manual]]

Latest revision as of 18:19, 27 April 2010

gflAverage

The gflAverage function :

GFL_ERROR gflAverage(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflSoften

The gflSoften function :

GFL_ERROR gflSoften(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 percentage
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
percentage
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflBlur

The gflBlur function :

GFL_ERROR gflBlur(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 percentage
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
percentage
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflGaussianBlur

The gflGaussianBlur function :

GFL_ERROR gflGaussianBlur(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflMaximum

The gflMaximum function :

GFL_ERROR gflMaximum(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflMinimum

The gflMinimum function :

GFL_ERROR gflMinimum(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflMedianBox

The gflMedianBox function :

GFL_ERROR gflMedianBox(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflMedianCross

The gflMedianCross function :

GFL_ERROR gflMedianCross(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 filter_size
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter_size
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflSharpen

The gflSharpen function :

GFL_ERROR gflSharpen(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  GFL_INT32 percentage
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
percentage
To do.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEnhanceDetail

The gflEnhanceDetail function :

GFL_ERROR gflEnhanceDetail(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEnhanceFocus

The gflEnhanceFocus function :

GFL_ERROR gflEnhanceFocus(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflFocusRestoration

The gflFocusRestoration function :

GFL_ERROR gflFocusRestoration(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEdgeDetectLight

The gflEdgeDetectLight function :

GFL_ERROR gflEdgeDetectLight(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEdgeDetectMedium

The gflEdgeDetectMedium function :

GFL_ERROR gflEdgeDetectMedium(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEdgeDetectHeavy

The gflEdgeDetectHeavy function :

GFL_ERROR gflEdgeDetectHeavy(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEmboss

The gflEmboss function :

GFL_ERROR gflEmboss(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflEmbossMore

The gflEmbossMore function :

GFL_ERROR gflEmbossMore(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.

gflConvolve

The gflConvolve function applies a convolution matrix on a picture.

GFL_ERROR gflConvolve(
  GFL_BITMAP* src,  
  GFL_BITMAP** dst,  
  const GFL_FILTER* filter
);

Parameters

src
Pointer to a GFL_BITMAP structure.
dst
Address of a pointer to a GFL_BITMAP structure. NULL if on the same instance.
filter
Pointer to a GFL_FILTER structure.

Return value

The function returns GFL_NO_ERROR if it is successful or a value of GFL_ERROR.