xtd::drawing::native::pen Class Reference

Inheritance diagram for xtd::drawing::native::pen:

Definition

Contains pen native API.

Namespace

xtd::drawing::native

Library

xtd.drawing.native

Warning

Internal use only

Protected Static Methods
static intptr	create ()
	Creates a pen.
static void	solid_color (intptr pen, xtd::byte a, xtd::byte r, xtd::byte g, xtd::byte b, float width, float dash_offset, std::vector< float > dashes)
	Sets solid color pen with specified color, width, dash offset and dash array.
static void	hatch_fill (intptr pen, intptr brush, float width)
	Sets hatch fill pen with specified hatch fill brush and width.
static void	conical_gradient (intptr pen, intptr brush, float width)
	Sets conical gradient pen with specified conical gradient brush and width.
static void	end_cap (intptr pen, int32 line_cap)
	Sets the cap style used at the end of lines drawn with the pen.
static void	linear_gradient (intptr pen, intptr brush, float width)
	Sets linear gradient pen with specified linear gradient brush and width.
static void	line_join (intptr pen, int32 line_join)
	Sets the join style for the ends of two consecutive lines drawn with the pen.
static void	miter_limit (intptr pen, float miter_limit)
	Sets the limit of the thickness of the join on a mitered corner.
static void	radial_gradient (intptr pen, intptr brush, float width)
	Sets radial gradient pen with specified radial gradient brush and width.
static void	start_cap (intptr pen, int32 line_cap)
	Sets the cap style used at the start of lines drawn with the pen.
static void	texture_fill (intptr pen, intptr brush, float width)
	Sets texture fill pen with specified texture fill brush and width.
static void	destroy (intptr pen)
	Destroys a pen.

Member Function Documentation

create()

static intptr xtd::drawing::native::pen::create ( )

staticprotected

Creates a pen.

Returns

The created pen handle.

Warning

Internal use only

solid_color()

static void xtd::drawing::native::pen::solid_color ( intptr  pen, xtd::byte  a, xtd::byte  r, xtd::byte  g, xtd::byte  b, float  width, float  dash_offset, std::vector< float >  dashes  )

staticprotected

Sets solid color pen with specified color, width, dash offset and dash array.

Parameters

pen	the pen handle.
a	The alpha component of the color.
r	The red component of the color.
g	The green component of the color.
b	The blue component of the color.
width	The width of the pen in pixels.
dash_offset	The offset of the dash.
dashes	A dash array that represent the format of dash. If the array of dashes is empty then the pen is a solid type.

Warning

Internal use only

hatch_fill()

static void xtd::drawing::native::pen::hatch_fill ( intptr  pen, intptr  brush, float  width  )

staticprotected

Sets hatch fill pen with specified hatch fill brush and width.

Parameters

pen	the pen handle.
brush	the hatch brush handle.
width	The width of the pen in pixels.

Warning

Internal use only

conical_gradient()

static void xtd::drawing::native::pen::conical_gradient ( intptr  pen, intptr  brush, float  width  )

staticprotected

Sets conical gradient pen with specified conical gradient brush and width.

Parameters

pen	the pen handle.
brush	the conical gradient brush handle.
width	The width of the pen in pixels.

Warning

Internal use only

end_cap()

static void xtd::drawing::native::pen::end_cap ( intptr  pen, int32  line_cap  )

staticprotected

Sets the cap style used at the end of lines drawn with the pen.

Parameters

pen	the pen handle.
value	A value that represents the cap style used at the end of lines drawn with the pen (see line_saps.h for more information).

Warning

Internal use only

linear_gradient()

static void xtd::drawing::native::pen::linear_gradient ( intptr  pen, intptr  brush, float  width  )

staticprotected

Sets linear gradient pen with specified linear gradient brush and width.

Parameters

pen	the pen handle.
brush	the linear gradient brush handle.
width	The width of the pen in pixels.

Warning

Internal use only

line_join()

static void xtd::drawing::native::pen::line_join ( intptr  pen, int32  line_join  )

staticprotected

Sets the join style for the ends of two consecutive lines drawn with the pen.

Parameters

pen	the pen handle.
line_join	A value that represents the join style for the ends of two consecutive lines drawn with the pen (see line_joins.h for more information).

Warning

Internal use only

miter_limit()

static void xtd::drawing::native::pen::miter_limit ( intptr  pen, float  miter_limit  )

staticprotected

Sets the limit of the thickness of the join on a mitered corner.

Parameters

pen	the pen handle.
miter_limit	The limit of the thickness of the join on a mitered corner.

Warning

Internal use only

radial_gradient()

static void xtd::drawing::native::pen::radial_gradient ( intptr  pen, intptr  brush, float  width  )

staticprotected

Sets radial gradient pen with specified radial gradient brush and width.

Parameters

pen	the pen handle.
brush	the radial gradient brush handle.
width	The width of the pen in pixels.

Warning

Internal use only

start_cap()

static void xtd::drawing::native::pen::start_cap ( intptr  pen, int32  line_cap  )

staticprotected

Sets the cap style used at the start of lines drawn with the pen.

Parameters

pen	the pen handle.
value	A value that represents the cap style used at the start of lines drawn with the pen (see line_saps.h for more information).

Warning

Internal use only

texture_fill()

static void xtd::drawing::native::pen::texture_fill ( intptr  pen, intptr  brush, float  width  )

staticprotected

Sets texture fill pen with specified texture fill brush and width.

Parameters

pen	the pen handle.
brush	the texture fill brush handle.
width	The width of the pen in pixels.

Warning

Internal use only

destroy()

static void xtd::drawing::native::pen::destroy ( intptr  pen )

staticprotected

Destroys a pen.

Parameters

pen	The pen handle to destroy.

Warning

Internal use only

---

The documentation for this class was generated from the following file:

• xtd.drawing.native/include/xtd/drawing/native/pen.hpp