Marblecore Imaging Library Documentation

Documentation Introduction
Documentation / Marblecore Imaging / Methods / DrawTextWithShadow

DrawTextWithShadow method

Draws text with shadow on the current image canvas.

Syntax

Boolean DrawTextWithShadow(strText As String, nLeft As Number, nTop As Number, nShadowColor As Number, nShadowOpacity As Number, nShadowOffset As Number, nWidth As Number, nHeight As Number, bNoWrap As State, strFontFace As String, nFontSize As Number, nFontColor As Number, nFontOpacity As Number, bFontBold As State, bFontItalic As State, bFontUnderline As State, bFontStrikeout As State, bFontAntiAliasing As State, nFontAlignment As Alignment, nFontRotation As Number, nFontShearX As Number, nFontShearY As Number)

Return value

Returns true if the function succeeded.

Parameters

ParameterTypeRequiredDescription
strTextStringYesText to draw.
nLeftNumberYesLeft coordinate for the text.
nTopNumberYesTop coordinate for the text.
nShadowColorNumberNoOptional parameter which specifies the shadow color.
nShadowOpacityNumberNoOptional parameter which specifies the shadow opacity.
nShadowOffsetNumberNoOptional parameter which specifies the shadow distance or offset. If not specified or 0 (zero) an offset is calculated.
nWidthNumberNoOptional parameter which specifies if horizontal text clipping is enabled. A value of 0 (zero) means clipping is disabled. A value above 0 specifies the width of the clip box.
nHeightNumberNoOptional parameter which specifies if vertical text clipping is enabled. A value of 0 (zero) means clipping is disabled. A value above 0 specifies the height of the clip box.
bNoWrapState (Enumeration)NoOptional parameter which disables or enables text wrapping. Wrapping is enabled by default (so this no-wrap parameter is disabled by default) when a positive value is passed to the nWidth parameter.
strFontFaceStringNoOptional parameter which specifies the font face.
nFontSizeNumberNoOptional parameter which specifies the font size.
nFontColorNumberNoOptional parameter which specifies the font color.
nFontOpacityNumberNoOptional parameter which specifies the font opacity.
bFontBoldState (Enumeration)NoOptional parameter which enables or disables the bold font style.
bFontItalicState (Enumeration)NoOptional parameter which enables or disables the italic font style.
bFontUnderlineState (Enumeration)NoOptional parameter which enables or disables the underline font style.
bFontStrikeoutState (Enumeration)NoOptional parameter which enables or disables the strikeout font style.
bFontAntiAliasingState (Enumeration)NoOptional parameter which enables or disables the font anti-aliasing.
nFontAlignmentAlignment (Enumeration)NoOptional parameter which specifies the alignment of the text.
nFontRotationNumberNoOptional parameter which specifies the rotation angle of the text in degrees.
nFontShearXNumberNoOptional parameter which specifies the horizontal shear percentage of the text.
nFontShearYNumberNoOptional parameter which specifies the vertical shear percentage of the text.

Example

The example below shows how to use the method. If you take a look at the example code, assume there is a reference to the Marblecore Imaging object with the name 'MarblecoreImaging'. Transparent parts of the image are displayed using a checkerboard pattern.
 
 
1 // Creates a new transparent image
2 MarblecoreImaging.Create(150, 150, true);
3 
4 // Execute the operation
5 MarblecoreImaging.DrawTextWithShadow("Demo", 25, 45, 0, 75, 8);
6 
7 // Save the modified image to the specified file
8 MarblecoreImaging.SaveToFile("example-drawtextwithshadow.jpg");

Category

Text drawing

See also

DrawTextInGradient | DrawTextInGradientUsingWarp | DrawTextInGradientWithBorder | DrawTextInGradientWithBorderAndShadow | DrawTextInGradientWithBorderAndShadowUsingWarp | DrawTextInGradientWithBorderUsingWarp | DrawTextInGradientWithShadow | DrawTextInGradientWithShadowUsingWarp | DrawTextNormal | DrawTextUsingWarp | DrawTextWithBorder | DrawTextWithBorderUsingWarp | DrawTextWithShadowUsingWarp | GetTextHeight | GetTextWidth