History of setDialogImageMode

== Syntax ==

:setDialogImageMode(int mode, int stretchMode)

== Arguments ==

:mode

:: How the background image will be displayed. 0 for exact size, 1 for tiled, 2 for stretched-to-fit.

:stretchMode

:: The algorithm used to stretch the bitmap to fit.

== Description ==

:Changes how the background image is displayed / resized in the filter dialog background. Under some conditions, e.g. STRETCHED dialog attribute, this could take some time to redraw - by using lockWindow(1) in front of the code and lockWindow(0) afterwards, the changes should only take a few milliseconds.

: The stretchMode parameter takes values from the Windows SetStretchBltMode function (see https://msdn.microsoft.com/en-us/library/windows/desktop/dd145089(v=vs.85).aspx ). There is almost no good reason to use anything except the COLORONCOLOR algorithm, which is the default, so it is best to leave stretchMode set to 0 at all times.

== Example ==

<code>

// Make the background image tiled / repeating

setDialogImageMode(1, 0);

// Make the background image stretch to fit the window

setDialogImageMode(2, 0);

</code>

== See Also ==

:setDialogImage

== Comments ==

:Everyone can add his comments about his experiences with this function here. Tips for using it are welcome, too.