Skip to content

Commit eb43abd

Browse files
TylerMSFTTylerMSFT
TylerMSFT
authored and
TylerMSFT
committed
acrolinx
1 parent 33f4751 commit eb43abd

File tree

1 file changed

+48
-48
lines changed

1 file changed

+48
-48
lines changed

‎docs/mfc/reference/cd2dbrush-class.md

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ ms.date: "11/04/2016"
55
f1_keywords: ["CD2DBrush", "AFXRENDERTARGET/CD2DBrush", "AFXRENDERTARGET/CD2DBrush::CD2DBrush", "AFXRENDERTARGET/CD2DBrush::Attach", "AFXRENDERTARGET/CD2DBrush::Destroy", "AFXRENDERTARGET/CD2DBrush::Detach", "AFXRENDERTARGET/CD2DBrush::Get", "AFXRENDERTARGET/CD2DBrush::GetOpacity", "AFXRENDERTARGET/CD2DBrush::GetTransform", "AFXRENDERTARGET/CD2DBrush::IsValid", "AFXRENDERTARGET/CD2DBrush::SetOpacity", "AFXRENDERTARGET/CD2DBrush::SetTransform", "AFXRENDERTARGET/CD2DBrush::m_pBrush", "AFXRENDERTARGET/CD2DBrush::m_pBrushProperties"]
66
helpviewer_keywords: ["CD2DBrush [MFC], CD2DBrush", "CD2DBrush [MFC], Attach", "CD2DBrush [MFC], Destroy", "CD2DBrush [MFC], Detach", "CD2DBrush [MFC], Get", "CD2DBrush [MFC], GetOpacity", "CD2DBrush [MFC], GetTransform", "CD2DBrush [MFC], IsValid", "CD2DBrush [MFC], SetOpacity", "CD2DBrush [MFC], SetTransform", "CD2DBrush [MFC], m_pBrush", "CD2DBrush [MFC], m_pBrushProperties"]
77
---
8-
# CD2DBrush Class
8+
# `CD2DBrush` Class
99

1010
A wrapper for `ID2D1Brush`.
1111

@@ -21,41 +21,41 @@ class CD2DBrush : public CD2DResource;
2121

2222
|Name|Description|
2323
|----------|-----------------|
24-
|[CD2DBrush::CD2DBrush](#cd2dbrush)|Constructs a CD2DBrush object.|
25-
|[CD2DBrush::~CD2DBrush](#_dtorcd2dbrush)|The destructor. Called when a D2D brush object is being destroyed.|
24+
|[`CD2DBrush::CD2DBrush`](#cd2dbrush)|Constructs a `CD2DBrush` object.|
25+
|[`CD2DBrush::~CD2DBrush`](#_dtorcd2dbrush)|The destructor. Called when a D2D brush object is being destroyed.|
2626

2727
### Public Methods
2828

2929
|Name|Description|
3030
|----------|-----------------|
31-
|[CD2DBrush::Attach](#attach)|Attaches existing resource interface to the object|
32-
|[CD2DBrush::Destroy](#destroy)|Destroys a CD2DBrush object. (Overrides [CD2DResource::Destroy](../../mfc/reference/cd2dresource-class.md#destroy).)|
33-
|[CD2DBrush::Detach](#detach)|Detaches resource interface from the object|
34-
|[CD2DBrush::Get](#get)|Returns ID2D1Brush interface|
35-
|[CD2DBrush::GetOpacity](#getopacity)|Gets the degree of opacity of this brush|
36-
|[CD2DBrush::GetTransform](#gettransform)|Gets the current transform of the brush|
37-
|[CD2DBrush::IsValid](#isvalid)|Checks resource validity (Overrides [CD2DResource::IsValid](../../mfc/reference/cd2dresource-class.md#isvalid).)|
38-
|[CD2DBrush::SetOpacity](#setopacity)|Sets the degree of opacity of this brush|
39-
|[CD2DBrush::SetTransform](#settransform)|Applies the specified transform to the brush, replacing the existing transformation. All subsequent drawing operations occur in the transformed space|
31+
|[`CD2DBrush::Attach`](#attach)|Attaches existing resource interface to the object|
32+
|[`CD2DBrush::Destroy`](#destroy)|Destroys a `CD2DBrush` object. (Overrides [`CD2DResource::Destroy`](../../mfc/reference/cd2dresource-class.md#destroy).)|
33+
|[`CD2DBrush::Detach`](#detach)|Detaches resource interface from the object|
34+
|[`CD2DBrush::Get`](#get)|Returns `ID2D1Brush` interface|
35+
|[`CD2DBrush::GetOpacity`](#getopacity)|Gets the degree of opacity of this brush|
36+
|[`CD2DBrush::GetTransform`](#gettransform)|Gets the current transform of the brush|
37+
|[`CD2DBrush::IsValid`](#isvalid)|Checks resource validity (Overrides [`CD2DResource::IsValid`](../../mfc/reference/cd2dresource-class.md#isvalid).)|
38+
|[`CD2DBrush::SetOpacity`](#setopacity)|Sets the degree of opacity of this brush|
39+
|[`CD2DBrush::SetTransform`](#settransform)|Applies the specified transform to the brush, replacing the existing transformation. All subsequent drawing operations occur in the transformed space|
4040

4141
### Public Operators
4242

4343
|Name|Description|
4444
|----------|-----------------|
45-
|[CD2DBrush::operator ID2D1Brush*](#operator_id2d1brush_star)|Returns ID2D1Brush interface|
45+
|[`CD2DBrush::operator ID2D1Brush*`](#operator_id2d1brush_star)|Returns `ID2D1Brush` interface|
4646

4747
### Protected Data Members
4848

4949
|Name|Description|
5050
|----------|-----------------|
51-
|[CD2DBrush::m_pBrush](#m_pbrush)|Stores a pointer to an ID2D1Brush object.|
52-
|[CD2DBrush::m_pBrushProperties](#m_pbrushproperties)|Brush properties.|
51+
|[`CD2DBrush::m_pBrush`](#m_pbrush)|Stores a pointer to an `ID2D1Brush` object.|
52+
|[`CD2DBrush::m_pBrushProperties`](#m_pbrushproperties)|Brush properties.|
5353

5454
## Inheritance Hierarchy
5555

56-
[CObject](../../mfc/reference/cobject-class.md)
56+
[`CObject`](../../mfc/reference/cobject-class.md)
5757

58-
[CD2DResource](../../mfc/reference/cd2dresource-class.md)
58+
[`CD2DResource`](../../mfc/reference/cd2dresource-class.md)
5959

6060
`CD2DBrush`
6161

@@ -65,7 +65,7 @@ class CD2DBrush : public CD2DResource;
6565

6666
## <a name="_dtorcd2dbrush"></a> `CD2DBrush::~CD2DBrush`
6767

68-
The destructor. Called when a D2D brush object is being destroyed.
68+
The destructor. Called when a `D2D` brush object is being destroyed.
6969

7070
```
7171
virtual ~CD2DBrush();
@@ -81,12 +81,12 @@ void Attach(ID2D1Brush* pResource);
8181
8282
### Parameters
8383
84-
*pResource*\
85-
Existing resource interface. Cannot be NULL.
84+
*`pResource`*\
85+
Existing resource interface. Can't be `NULL`.
8686
8787
## <a name="cd2dbrush"></a> `CD2DBrush::CD2DBrush`
8888
89-
Constructs a CD2DBrush object.
89+
Constructs a `CD2DBrush` object.
9090
9191
```
9292
CD2DBrush(
@@ -97,24 +97,24 @@ CD2DBrush(
9797
9898
### Parameters
9999
100-
*pParentTarget*\
100+
*`pParentTarget`*\
101101
A pointer to the render target.
102102
103-
*pBrushProperties*\
103+
*`pBrushProperties`*\
104104
A pointer to the opacity and transformation of a brush.
105105
106-
*bAutoDestroy*\
107-
Indicates that the object will be destroyed by owner (pParentTarget).
106+
*`bAutoDestroy`*\
107+
Indicates that the owner (`pParentTarget`) will destroy the object.
108108
109-
## <a name="destroy"></a> CD2DBrush::Destroy
109+
## <a name="destroy"></a> `CD2DBrush::Destroy`
110110
111-
Destroys a CD2DBrush object.
111+
Destroys a `CD2DBrush` object.
112112
113113
```
114114
virtual void Destroy();
115115
```
116116
117-
## <a name="detach"></a> CD2DBrush::Detach
117+
## <a name="detach"></a> `CD2DBrush::Detach`
118118
119119
Detaches resource interface from the object.
120120
@@ -126,19 +126,19 @@ ID2D1Brush* Detach();
126126
127127
Pointer to detached resource interface.
128128
129-
## <a name="get"></a> CD2DBrush::Get
129+
## <a name="get"></a> `CD2DBrush::Get`
130130
131-
Returns ID2D1Brush interface
131+
Returns `ID2D1Brush` interface
132132
133133
```
134134
ID2D1Brush* Get();
135135
```
136136
137137
### Return Value
138138
139-
Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.
139+
Pointer to an `ID2D1Brush` interface or `NULL` if object isn't initialized yet.
140140
141-
## <a name="getopacity"></a> CD2DBrush::GetOpacity
141+
## <a name="getopacity"></a> `CD2DBrush::GetOpacity`
142142
143143
Gets the degree of opacity of this brush
144144
@@ -148,9 +148,9 @@ FLOAT GetOpacity() const;
148148
149149
### Return Value
150150
151-
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together.
151+
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they're multiplied together.
152152
153-
## <a name="gettransform"></a> CD2DBrush::GetTransform
153+
## <a name="gettransform"></a> `CD2DBrush::GetTransform`
154154
155155
Gets the current transform of the brush
156156
@@ -160,10 +160,10 @@ void GetTransform(D2D1_MATRIX_3X2_F* transform) const;
160160

161161
### Parameters
162162

163-
*transform*\
163+
*`transform`*\
164164
When this returns, contains the current transform of the brush. This parameter is passed uninitialized.
165165

166-
## <a name="isvalid"></a> CD2DBrush::IsValid
166+
## <a name="isvalid"></a> `CD2DBrush::IsValid`
167167

168168
Checks resource validity
169169

@@ -173,37 +173,37 @@ virtual BOOL IsValid() const;
173173

174174
### Return Value
175175

176-
TRUE if resource is valid; otherwise FALSE.
176+
`TRUE` if resource is valid; otherwise `FALSE`.
177177

178-
## <a name="m_pbrush"></a> CD2DBrush::m_pBrush
178+
## <a name="m_pbrush"></a> `CD2DBrush::m_pBrush`
179179

180-
Stores a pointer to an ID2D1Brush object.
180+
Stores a pointer to an `ID2D1Brush` object.
181181

182182
```
183183
ID2D1Brush* m_pBrush;
184184
```
185185

186-
## <a name="m_pbrushproperties"></a> CD2DBrush::m_pBrushProperties
186+
## <a name="m_pbrushproperties"></a> `CD2DBrush::m_pBrushProperties`
187187

188188
Brush properties.
189189

190190
```
191191
CD2DBrushProperties* m_pBrushProperties;
192192
```
193193

194-
## <a name="operator_id2d1brush_star"></a> CD2DBrush::operator ID2D1Brush*
194+
## <a name="operator_id2d1brush_star"></a> `CD2DBrush::operator ID2D1Brush*`
195195

196-
Returns ID2D1Brush interface
196+
Returns `ID2D1Brush` interface
197197

198198
```
199199
operator ID2D1Brush*();
200200
```
201201

202202
### Return Value
203203

204-
Pointer to an ID2D1Brush interface or NULL if object is not initialized yet.
204+
Pointer to an `ID2D1Brush` interface or NULL if object isn't initialized yet.
205205

206-
## <a name="setopacity"></a> CD2DBrush::SetOpacity
206+
## <a name="setopacity"></a> `CD2DBrush::SetOpacity`
207207

208208
Sets the degree of opacity of this brush
209209

@@ -213,10 +213,10 @@ void SetOpacity(FLOAT opacity);
213213
214214
### Parameters
215215
216-
*opacity*\
217-
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they are multiplied together.
216+
*`opacity`*\
217+
A value between zero and 1 that indicates the opacity of the brush. This value is a constant multiplier that linearly scales the alpha value of all pixels filled by the brush. The opacity values are clamped in the range 0 to 1 before they're multiplied together.
218218
219-
## <a name="settransform"></a> CD2DBrush::SetTransform
219+
## <a name="settransform"></a> `CD2DBrush::SetTransform`
220220
221221
Applies the specified transform to the brush, replacing the existing transformation. All subsequent drawing operations occur in the transformed space.
222222
@@ -226,7 +226,7 @@ void SetTransform(const D2D1_MATRIX_3X2_F* transform);
226226

227227
### Parameters
228228

229-
*transform*\
229+
*`transform`*\
230230
The transform to apply to the brush
231231

232232
## See also

0 commit comments

Comments
 (0)