Skip to content

Commit 92c2669

Browse files
author
mtx48109
committed
format mfc reference pr3
1 parent fa4d84a commit 92c2669

30 files changed

+493
-490
lines changed

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ void Attach(ID2D1Bitmap* pResource);
103103
```
104104

105105
### Parameters
106-
`pResource`
106+
*pResource*
107107
Existing resource interface. Cannot be NULL
108108

109109
## <a name="cd2dbitmap"></a> CD2DBitmap::CD2DBitmap
@@ -138,25 +138,25 @@ CD2DBitmap(
138138
```
139139

140140
### Parameters
141-
`pParentTarget`
141+
*pParentTarget*
142142
A pointer to the render target.
143143

144-
`uiResID`
144+
*uiResID*
145145
The resource ID number of the resource.
146146

147-
`lpszType`
147+
*lpszType*
148148
Pointer to a null-terminated string that contains the resource type.
149149

150-
`sizeDest`
150+
*sizeDest*
151151
Destination size of the bitmap.
152152

153-
`bAutoDestroy`
153+
*bAutoDestroy*
154154
Indicates that the object will be destroyed by owner (pParentTarget).
155155

156-
`lpszPath`
156+
*lpszPath*
157157
Pointer to a null-terminated string that contains the name of file.
158158

159-
`hbmpSrc`
159+
*hbmpSrc*
160160
Handle to the bitmap.
161161

162162
## <a name="commoninit"></a> CD2DBitmap::CommonInit
@@ -177,13 +177,13 @@ HRESULT CopyFromBitmap(
177177
```
178178

179179
### Parameters
180-
`pBitmap`
180+
*pBitmap*
181181
The bitmap to copy from
182182

183-
`destPoint`
183+
*destPoint*
184184
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
185185

186-
`srcRect`
186+
*srcRect*
187187
The area of bitmap to copy
188188

189189
### Return Value
@@ -200,13 +200,13 @@ HRESULT CopyFromMemory(
200200
```
201201

202202
### Parameters
203-
`srcData`
203+
*srcData*
204204
The data to copy
205205

206-
`pitch`
206+
*pitch*
207207
The stride, or pitch, of the source bitmap stored in srcData. The stride is the byte count of a scanline (one row of pixels in memory). The stride can be computed from the following formula: pixel width * bytes per pixel + memory padding
208208

209-
`destRect`
209+
*destRect*
210210
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
211211

212212
### Return Value
@@ -223,13 +223,13 @@ HRESULT CopyFromRenderTarget(
223223
```
224224

225225
### Parameters
226-
`pRenderTarget`
226+
*pRenderTarget*
227227
The render target that contains the region to copy
228228

229-
`destPoint`
229+
*destPoint*
230230
In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied
231231

232-
`srcRect`
232+
*srcRect*
233233
The area of renderTarget to copy
234234

235235
### Return Value
@@ -243,7 +243,7 @@ virtual HRESULT Create(CRenderTarget* pRenderTarget);
243243
```
244244

245245
### Parameters
246-
`pRenderTarget`
246+
*pRenderTarget*
247247
A pointer to the render target.
248248

249249
### Return Value

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ void Attach(ID2D1Brush* pResource);
8282
```
8383

8484
### Parameters
85-
`pResource`
85+
*pResource*
8686
Existing resource interface. Cannot be NULL
8787

8888
## <a name="cd2dbrush"></a> CD2DBrush::CD2DBrush
@@ -96,13 +96,13 @@ CD2DBrush(
9696
```
9797

9898
### Parameters
99-
`pParentTarget`
99+
*pParentTarget*
100100
A pointer to the render target.
101101

102-
`pBrushProperties`
102+
*pBrushProperties*
103103
A pointer to the opacity and transformation of a brush.
104104

105-
`bAutoDestroy`
105+
*bAutoDestroy*
106106
Indicates that the object will be destroyed by owner (pParentTarget).
107107

108108
## <a name="destroy"></a> CD2DBrush::Destroy
@@ -150,7 +150,7 @@ void GetTransform(D2D1_MATRIX_3X2_F* transform) const;
150150
```
151151

152152
### Parameters
153-
`transform`
153+
*transform*
154154
When this returns, contains the current transform of the render target. This parameter is passed uninitialized
155155

156156
## <a name="isvalid"></a> CD2DBrush::IsValid
@@ -195,7 +195,7 @@ void SetOpacity(FLOAT opacity);
195195
```
196196

197197
### Parameters
198-
`opacity`
198+
*opacity*
199199
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
200200

201201
## <a name="settransform"></a> CD2DBrush::SetTransform
@@ -206,7 +206,7 @@ void SetTransform(const D2D1_MATRIX_3X2_F* transform);
206206
```
207207

208208
### Parameters
209-
`transform`
209+
*transform*
210210
The transform to apply to the render target
211211

212212
## See Also

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

Lines changed: 74 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,74 @@
1-
---
2-
title: "CD2DBrushProperties Class | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.technology: ["cpp-mfc"]
6-
ms.topic: "reference"
7-
f1_keywords: ["CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CommonInit"]
8-
dev_langs: ["C++"]
9-
helpviewer_keywords: ["CD2DBrushProperties [MFC], CD2DBrushProperties", "CD2DBrushProperties [MFC], CommonInit"]
10-
ms.assetid: c77d717f-0a16-4d74-b2ce-0ae1766ed6f9
11-
author: "mikeblome"
12-
ms.author: "mblome"
13-
ms.workload: ["cplusplus"]
14-
---
15-
# CD2DBrushProperties Class
16-
A wrapper for `D2D1_BRUSH_PROPERTIES`.
17-
18-
## Syntax
19-
20-
```
21-
class CD2DBrushProperties : public D2D1_BRUSH_PROPERTIES;
22-
```
23-
24-
## Members
25-
26-
### Public Constructors
27-
28-
|Name|Description|
29-
|----------|-----------------|
30-
|[CD2DBrushProperties::CD2DBrushProperties](#cd2dbrushproperties)|Overloaded. Creates a `CD2D_BRUSH_PROPERTIES` structure|
31-
32-
### Protected Methods
33-
34-
|Name|Description|
35-
|----------|-----------------|
36-
|[CD2DBrushProperties::CommonInit](#commoninit)|Initializes the object|
37-
38-
## Inheritance Hierarchy
39-
`D2D1_BRUSH_PROPERTIES`
40-
41-
`CD2DBrushProperties`
42-
43-
## Requirements
44-
**Header:** afxrendertarget.h
45-
46-
## <a name="cd2dbrushproperties"></a> CD2DBrushProperties::CD2DBrushProperties
47-
Creates a CD2D_BRUSH_PROPERTIES structure
48-
49-
```
50-
CD2DBrushProperties();
51-
CD2DBrushProperties(FLOAT _opacity);
52-
53-
CD2DBrushProperties(
54-
D2D1_MATRIX_3X2_F _transform,
55-
FLOAT _opacity = 1.);
56-
```
57-
58-
### Parameters
59-
`_opacity`
60-
The base opacity of the brush. The default value is 1.0.
61-
62-
`_transform`
63-
The transformation to apply to the brush
64-
65-
## <a name="commoninit"></a> CD2DBrushProperties::CommonInit
66-
Initializes the object
67-
68-
```
69-
void CommonInit();
70-
```
71-
72-
## See Also
73-
[Classes](../../mfc/reference/mfc-classes.md)
1+
---
2+
title: "CD2DBrushProperties Class | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.technology: ["cpp-mfc"]
6+
ms.topic: "reference"
7+
f1_keywords: ["CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CD2DBrushProperties", "AFXRENDERTARGET/CD2DBrushProperties::CommonInit"]
8+
dev_langs: ["C++"]
9+
helpviewer_keywords: ["CD2DBrushProperties [MFC], CD2DBrushProperties", "CD2DBrushProperties [MFC], CommonInit"]
10+
ms.assetid: c77d717f-0a16-4d74-b2ce-0ae1766ed6f9
11+
author: "mikeblome"
12+
ms.author: "mblome"
13+
ms.workload: ["cplusplus"]
14+
---
15+
# CD2DBrushProperties Class
16+
A wrapper for `D2D1_BRUSH_PROPERTIES`.
17+
18+
## Syntax
19+
20+
```
21+
class CD2DBrushProperties : public D2D1_BRUSH_PROPERTIES;
22+
```
23+
24+
## Members
25+
26+
### Public Constructors
27+
28+
|Name|Description|
29+
|----------|-----------------|
30+
|[CD2DBrushProperties::CD2DBrushProperties](#cd2dbrushproperties)|Overloaded. Creates a `CD2D_BRUSH_PROPERTIES` structure|
31+
32+
### Protected Methods
33+
34+
|Name|Description|
35+
|----------|-----------------|
36+
|[CD2DBrushProperties::CommonInit](#commoninit)|Initializes the object|
37+
38+
## Inheritance Hierarchy
39+
`D2D1_BRUSH_PROPERTIES`
40+
41+
`CD2DBrushProperties`
42+
43+
## Requirements
44+
**Header:** afxrendertarget.h
45+
46+
## <a name="cd2dbrushproperties"></a> CD2DBrushProperties::CD2DBrushProperties
47+
Creates a CD2D_BRUSH_PROPERTIES structure
48+
49+
```
50+
CD2DBrushProperties();
51+
CD2DBrushProperties(FLOAT _opacity);
52+
53+
54+
CD2DBrushProperties(
55+
D2D1_MATRIX_3X2_F _transform,
56+
FLOAT _opacity = 1.);
57+
```
58+
59+
### Parameters
60+
*_opacity*
61+
The base opacity of the brush. The default value is 1.0.
62+
63+
*_transform*
64+
The transformation to apply to the brush
65+
66+
## <a name="commoninit"></a> CD2DBrushProperties::CommonInit
67+
Initializes the object
68+
69+
```
70+
void CommonInit();
71+
```
72+
73+
## See Also
74+
[Classes](../../mfc/reference/mfc-classes.md)

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,16 @@ CD2DEllipse(
5252
```
5353

5454
### Parameters
55-
`rect`
55+
*rect*
5656
source rectangle
5757

58-
`ellipse`
58+
*ellipse*
5959
source ellipse
6060

61-
`ptCenter`
61+
*ptCenter*
6262
The center point of the ellipse.
6363

64-
`sizeRadius`
64+
*sizeRadius*
6565
The X-radius and Y-radius of the ellipse.
6666

6767
## See Also

0 commit comments

Comments
 (0)