TextureBrush Class

Summary: Each property of the TextureBrush class is a Brush object that uses an image to fill the interior of a shape. This class cannot be inherited.

Module: aspose.imaging.brushes

Full Name: aspose.imaging.brushes.TextureBrush

Inheritance: TransformBrush

Constructors

Name	Description
TextureBrush(image)	Initializes a new instance of the TextureBrush class that uses the specified image.
TextureBrush(image, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.
TextureBrush(image, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.
TextureBrush(image, destination_rectangle, image_attributes)	Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.
TextureBrush(image, destination_rectangle, image_attributes)	Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.
TextureBrush(image, wrap_mode)	Initializes a new instance of the TextureBrush class that uses the specified image and wrap mode.
TextureBrush(image, wrap_mode, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.
TextureBrush(image, wrap_mode, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.

Properties

Name	Type	Access	Description
disposed	bool	r	Gets a value indicating whether this instance is disposed.
image	Image	r	Gets the Image object associated with this TextureBrush object.
image_attributes	ImageAttributes	r	Gets the TextureBrush.image_attributes associated with this TextureBrush.
image_rectangle	RectangleF	r	Gets the Rectangle associated with this TextureBrush.
is_transform_changed	bool	r	Gets a value indicating whether transformations were changed in some way. For example setting the transformation matrix or calling any of the methods altering the transformation matrix. The property is introduced for backward compatibility with GDI+.
opacity	float	r/w	Gets or sets the brush opacity. The value should be between 0 and 1. Value of 0 means that brush is fully visible, value of 1 means the brush is fully opaque.
transform	Matrix	r/w	Gets or sets a copy Matrix that defines a local geometric transform for this TransformBrush.
wrap_mode	WrapMode	r/w	Gets or sets a WrapMode enumeration that indicates the wrap mode for this TransformBrush.

Methods

Name	Description
create_with_image_rect(image, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.
create_with_image_rect_attribs(image, destination_rectangle, image_attributes)	Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.
create_with_image_rect_f(image, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.
create_with_image_rect_f_attribs(image, destination_rectangle, image_attributes)	Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.
create_with_image_wrap_mode(image, wrap_mode)	Initializes a new instance of the TextureBrush class that uses the specified image and wrap mode.
create_with_image_wrap_mode_rect(image, wrap_mode, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.
create_with_image_wrap_mode_rect_f(image, wrap_mode, destination_rectangle)	Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.
deep_clone()	Creates a new deep clone of the current Brush.
multiply_transform(matrix)	Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix by prepending the specified Matrix.
multiply_transform(matrix, order)	Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix in the specified order.
reset_transform()	Resets the TransformBrush.transform property to identity.
rotate_transform(angle)	Rotates the local geometric transform by the specified amount. This method prepends the rotation to the transform.
rotate_transform(angle, order)	Rotates the local geometric transform by the specified amount in the specified order.
scale_transform(sx, sy)	Scales the local geometric transform by the specified amounts. This method prepends the scaling matrix to the transform.
scale_transform(sx, sy, order)	Scales the local geometric transform by the specified amounts in the specified order.
translate_transform(dx, dy)	Translates the local geometric transform by the specified dimensions. This method prepends the translation to the transform.
translate_transform(dx, dy, order)	Translates the local geometric transform by the specified dimensions in the specified order.

Constructor: TextureBrush(image)

 TextureBrush(image) 

Initializes a new instance of the TextureBrush class that uses the specified image.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.

Constructor: TextureBrush(image, destination_rectangle)

 TextureBrush(image, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	Rectangle	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.

Constructor: TextureBrush(image, destination_rectangle)

 TextureBrush(image, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	RectangleF	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.

Constructor: TextureBrush(image, destination_rectangle, image_attributes)

 TextureBrush(image, destination_rectangle, image_attributes) 

Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	Rectangle	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.
image_attributes	ImageAttributes	An ImageAttributes object that contains additional information about the image used by this TextureBrush object.

Constructor: TextureBrush(image, destination_rectangle, image_attributes)

 TextureBrush(image, destination_rectangle, image_attributes) 

Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	RectangleF	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.
image_attributes	ImageAttributes	An ImageAttributes object that contains additional information about the image used by this TextureBrush object.

Constructor: TextureBrush(image, wrap_mode)

 TextureBrush(image, wrap_mode) 

Initializes a new instance of the TextureBrush class that uses the specified image and wrap mode.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.

Constructor: TextureBrush(image, wrap_mode, destination_rectangle)

 TextureBrush(image, wrap_mode, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.
destination_rectangle	Rectangle	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.

Constructor: TextureBrush(image, wrap_mode, destination_rectangle)

 TextureBrush(image, wrap_mode, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.
destination_rectangle	RectangleF	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.

Method: create_with_image_rect(image, destination_rectangle) [static]

 create_with_image_rect(image, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	Rectangle	A RectangleF structure that represents the bounding rectangle for this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: create_with_image_rect_attribs(image, destination_rectangle, image_attributes) [static]

 create_with_image_rect_attribs(image, destination_rectangle, image_attributes) 

Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	Rectangle	A Rectangle structure that represents the bounding rectangle for this TextureBrush object.
image_attributes	ImageAttributes	An ImageAttributes object that contains additional information about the image used by this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: create_with_image_rect_f(image, destination_rectangle) [static]

 create_with_image_rect_f(image, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	RectangleF	A RectangleF structure that represents the bounding rectangle for this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: create_with_image_rect_f_attribs(image, destination_rectangle, image_attributes) [static]

 create_with_image_rect_f_attribs(image, destination_rectangle, image_attributes) 

Initializes a new instance of the TextureBrush class that uses the specified image, bounding rectangle, and image attributes.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
destination_rectangle	RectangleF	A RectangleF structure that represents the bounding rectangle for this TextureBrush object.
image_attributes	ImageAttributes	An ImageAttributes object that contains additional information about the image used by this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: create_with_image_wrap_mode(image, wrap_mode) [static]

 create_with_image_wrap_mode(image, wrap_mode) 

Initializes a new instance of the TextureBrush class that uses the specified image and wrap mode.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.

Returns

Type	Description
TextureBrush

Method: create_with_image_wrap_mode_rect(image, wrap_mode, destination_rectangle) [static]

 create_with_image_wrap_mode_rect(image, wrap_mode, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.
destination_rectangle	Rectangle	A RectangleF structure that represents the bounding rectangle for this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: create_with_image_wrap_mode_rect_f(image, wrap_mode, destination_rectangle) [static]

 create_with_image_wrap_mode_rect_f(image, wrap_mode, destination_rectangle) 

Initializes a new instance of the TextureBrush class that uses the specified image, wrap mode, and bounding rectangle.

Parameters:

Parameter	Type	Description
image	Image	The Image object with which this TextureBrush object fills interiors.
wrap_mode	WrapMode	A WrapMode enumeration that specifies how this TextureBrush object is tiled.
destination_rectangle	RectangleF	A RectangleF structure that represents the bounding rectangle for this TextureBrush object.

Returns

Type	Description
TextureBrush

Method: deep_clone()

 deep_clone() 

Creates a new deep clone of the current Brush.

Returns

Type	Description
Brush	A new Brush which is the deep clone of this Brush instance.

Method: multiply_transform(matrix)

 multiply_transform(matrix) 

Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix by prepending the specified Matrix.

Parameters:

Parameter	Type	Description
matrix	Matrix	The Matrix by which to multiply the geometric transform.

Method: multiply_transform(matrix, order)

 multiply_transform(matrix, order) 

Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix in the specified order.

Parameters:

Parameter	Type	Description
matrix	Matrix	The Matrix by which to multiply the geometric transform.
order	MatrixOrder	A MatrixOrder that specifies in which order to multiply the two matrices.

Method: rotate_transform(angle)

 rotate_transform(angle) 

Rotates the local geometric transform by the specified amount. This method prepends the rotation to the transform.

Parameters:

Parameter	Type	Description
angle	float	The angle of rotation.

Method: rotate_transform(angle, order)

 rotate_transform(angle, order) 

Rotates the local geometric transform by the specified amount in the specified order.

Parameters:

Parameter	Type	Description
angle	float	The angle of rotation.
order	MatrixOrder	A MatrixOrder that specifies whether to append or prepend the rotation matrix.

Method: scale_transform(sx, sy)

 scale_transform(sx, sy) 

Scales the local geometric transform by the specified amounts. This method prepends the scaling matrix to the transform.

Parameters:

Parameter	Type	Description
sx	float	The amount by which to scale the transform in the x-axis direction.
sy	float	The amount by which to scale the transform in the y-axis direction.

Method: scale_transform(sx, sy, order)

 scale_transform(sx, sy, order) 

Scales the local geometric transform by the specified amounts in the specified order.

Parameters:

Parameter	Type	Description
sx	float	The amount by which to scale the transform in the x-axis direction.
sy	float	The amount by which to scale the transform in the y-axis direction.
order	MatrixOrder	A MatrixOrder that specifies whether to append or prepend the scaling matrix.

Method: translate_transform(dx, dy)

 translate_transform(dx, dy) 

Translates the local geometric transform by the specified dimensions. This method prepends the translation to the transform.

Parameters:

Parameter	Type	Description
dx	float	The value of the translation in x.
dy	float	The value of the translation in y.

Method: translate_transform(dx, dy, order)

 translate_transform(dx, dy, order) 

Translates the local geometric transform by the specified dimensions in the specified order.

Parameters:

Parameter	Type	Description
dx	float	The value of the translation in x.
dy	float	The value of the translation in y.
order	MatrixOrder	The order (prepend or append) in which to apply the translation.