ID3DXFont::DrawText 메서드

정형된 텍스트를 드로잉(Drawing) 한다. 이 메서드는, ANSI 및 Unicode 캐릭터 라인을 지원 한다.

구문

INT DrawText(      

    LPCSTR pString,
    INT Count,
    LPRECT pRect,
    DWORD Format,
    D3DCOLOR Color
);

파라미터

pString
[in] 드로잉(Drawing) 하는 캐릭터 라인의 포인터. 이 파라미터는, ANSI 및 Unicode 캐릭터 라인을 지원 한다. UNICODE 또는 _UNICODE 가 정의되고 있는 경우, 캐릭터 라인의 형태는 LPCWSTR 가 아니면 안된다. 그 이외의 경우는, LPCSTR 가 아니면 안된다.
Count 파라미터가 -1 의 경우, 캐릭터 라인은 Null 로 끝날 필요가 있다.
Format 에 DT_MODIFYSTRING 가 포함되어 있는 경우는, 이 함수로 최대 4 문자까지 문자를 추가할 수 있다. 캐릭터 라인을 보관 유지하는 버퍼에는, 이러한 추가 문자를 저장 할 수 있는 충분한 크기가 필요하다.
Count
[in] 캐릭터 라인의 문자수를 지정한다. Count 가 -1 의 경우, 파라미터 pString 는 Null 종단 캐릭터 라인의 포인터라고 보여져ID3DXFont::DrawText 에 의해 문자수가 자동적으로 계산된다.
pRect
[in] 텍스트를 포맷 하는 직사각형의 논리 좌표를 저장 하는 RECT 구조체의 포인터.
Format
[in] 텍스트를 포맷 하는 메서드를 지정한다. 다음의 값을 임의에 조합할 수가 있다.
DT_BOTTOM
직사각형의 저부로 텍스트를 both and justification로 한다. 이 값은 DT_SINGLELINE 와 조합해 사용해야 한다.
DT_CALCRECT
직사각형의 폭과 높이를 계산한다. 텍스트가 복수행 있는 경우,ID3DXFont::DrawText 는 pRect 파라미터가 참조하는 직사각형의 폭을 사용해, 텍스트의 마지막 행이 포함되도록(듯이) 직사각형의 저변을 연장한다. 텍스트가 1 행만의 경우,ID3DXFont::DrawText 하행의 마지막 문자가 들어가도록(듯이) 직사각형의 우측의 옆의 위치를 수정한다. 어느 쪽의 경우도,ID3DXFont::DrawText 는 정형된 텍스트의 높이를 돌려주지만, 텍스트는 드로잉(Drawing) 하지 않는다.
DT_CENTER
직사각형내에서 텍스트를 수평 방향으로 centering로 한다.
DT_EDITCONTROL
멀티 라인 에디트 컨트롤의 텍스트 표시 특성을 복제한다. 특히, 평균의 문자폭은 에디트 컨트롤과 같은 방법으로 계산되어 부분적으로 보이는 마지막 행은 표시되지 않는다.
DT_END_ELLIPSIS or DT_PATH_ELLIPSIS
생략 기호를 추가하지 않고 캐릭터 라인을 잘라 버려 지정한 직사각형에 들어가도록(듯이) 한다. DT_MODIFYSTRING 플래그가 지정되고 있는 경우를 제외해, 캐릭터 라인은 수정되지 않는다.
DT_END_ELLIPSIS 는 캐릭터 라인의 최후로 문자를 잘라 버리기 위해서(때문에) 지정한다. DT_PATH_ELLIPSIS 는 캐릭터 라인의 중간으로 문자를 잘라 버리기 위해서(때문에) 지정한다. 캐릭터 라인에 backslash (\)가 포함되어 있는 경우, DT_PATH_ELLIPSIS 는 마지막 backslash보다 뒤에 있는 텍스트를 가능한 한 많이 보관 유지한다.
DT_EXPANDTABS
탭 문자를 확장한다. 탭 마다 디폴트의 문자수는 8 자이다. DT_WORD_ELLIPSIS, DT_PATH_ELLIPSIS, 및 DT_END_ELLIPSIS 의 각 값은,DT_EXPANDTABS 값과 함께는 사용할 수 없다.
DT_EXTERNALLEADING
행의 높이에 폰트의 외부 margin를 포함한다. 보통, 외부 margin는, 텍스트의 행의 높이에는 포함되지 않는다.
DT_HIDEPREFIX
Microsoft® Windows® 2000:텍스트에 포함되는 ampersand(&) 접두어 문자를 무시한다. ampersand(&)에 계속되는 문자에 밑줄은 붙지 않지만, 다른 무릎 관절 모닛크 접두어 문자는 그대로 처리된다.
예 :
입력 캐릭터 라인 :"A&bc&&d"
표준 :"A&d"
HIDEPREFIX:"Abc&d"
DT_NOPREFIX 및 DT_PREFIXONLY 와 비교하는 것.
DT_INTERNAL
시스템 폰트를 사용해 텍스트 메트릭스를 계산한다.
DT_LEFT
텍스트를 왼쪽 가지런히 해로 한다.
DT_MODIFYSTRING
캐릭터 라인을 수정해 표시된 텍스트에 맞춘다. DT_END_ELLIPSIS 또는 DT_PATH_ELLIPSIS 가 지정되고 있는 경우만, 이 플래그는 유효가 된다.
DT_NOCLIP
클리핑 하지 않고 드로잉(Drawing) 한다. ID3DXFont::DrawText 는,DT_NOCLIP 를 사용하면 약간 고속으로 있다.
DT_NOFULLWIDTHCHARBREAK
Windows 98, Windows 2000:2 바이트 캐릭터 세트 (DBCS)로 개행되지 않게 한다. 이것에 의해 개행 규칙은 1 바이트 캐릭터 세트 (SBCS)와 같게 된다. 예를 들어, 한국어판 Windows 로 아이콘 라벨을 읽기 쉽게 하기 위해서 사용된다. DT_WORDBREAK 가 지정되고 있는 경우만 유효하다.
DT_NOPREFIX
접두어 문자의 처리를 오프로 한다. 보통,ID3DXFont::DrawText 는 무릎 관절 모닛크 접두어 문자의 & 를, 그 후에 계속되는 문자에 밑줄을 붙이는 명령으로서 해석해, 무릎 관절 모닛크 접두어 문자가 && 와 2 개 계속되었을 경우는, & 를 1 개 출력하는 명령으로서 해석한다. DT_NOPREFIX 를 지정하는 것으로써, 이 처리는 오프가 된다. DT_HIDEPREFIX 및 DT_PREFIXONLY 와 비교하는 것.
DT_PREFIXONLY
Windows 2000:ampersand(&) (&) 접두어 문자에 계속되는 문자의 위치에서, 밑줄만을 드로잉(Drawing) 한다. 캐릭터 라인에 포함되는 문자는 드로잉(Drawing) 하지 않는다.
DT_RIGHT
텍스트를 우단 가지런히 해로 한다.
DT_RTLREADING
헤브라이어 또는 아라비아어의 폰트가 선택되고 있는 경우, 읽기의 순서가 쌍방향의 텍스트에 대해 오른쪽에서 왼쪽의 순서에 읽도록(듯이) 텍스트를 표시한다. 디폴트의 읽기의 순서는, 모든 텍스트로 왼쪽에서 오른쪽이 되고 있다.
DT_SINGLELINE
1 행에만 텍스트를 표시한다. 개행과 행송로 새로운 행으로 옮기지 않는다.
DT_TABSTOP
tab stop를 설정한다. Format 파라미터의 비트 15–8 (저위어의 고차원 바이트)에 의해 각 탭의 문자수를 지정한다. 탭 마다 디폴트의 문자수는 8 자이다. DT_CALCRECT,DT_EXTERNALLEADING,DT_INTERNAL,DT_NOCLIP, 및 DT_NOPREFIX 의 각 값은,DT_TABSTOP 값과 함께는 사용할 수 없다.
DT_TOP
선두행의 텍스트를 both and justification로 한다 (1 행만).
DT_VCENTER
상하 방향으로 텍스트를 centering로 한다 (1 행만).
DT_WORDBREAK
어를 분할한다. pRect 파라미터로 지정한 직사각형으로부터 말이 초과하는 경우, 말과 말의 사이에 자동적으로 개행된다. 개행/행 송의 순서도 개행이 된다.
DT_WORD_ELLIPSIS
직사각형에 들어가지 않는 텍스트를 잘라 버려 생략 기호를 추가한다.
Color
[in] 텍스트의 색. 더 자세한 정보는, 「D3DCOLOR 」를 참조할것.

반환값

성공했을 경우는, 논리적 단위를 사용해 텍스트의 높이를 돌려준다. DT_VCENTER 또는 DT_BOTTOM 가 지정되고 있는 경우는, lpRect->top 으로부터 드로잉(Drawing) 된 텍스트의 하단까지의 오프셋(offset)를 돌려준다.
실패했을 경우는, 제로를 돌려준다.

주의

이 함수는, ANSI 캐릭터 라인 및 Unicode 캐릭터 라인을 양쪽 모두 지원 하고 있다.
이 메서드는,IDirect3DDevice9::BeginScene /IDirect3DDevice9::EndScene 블록의 안쪽에서 호출해야 한다.
DT_NOCLIP 포맷이 사용되는 경우를 제외해, 이 메서드는, 지정된 직사각형의 외측에 텍스트가 초과하지 않게 텍스트를 잘라낸다. DT_SINGLELINE 포맷이 지정되고 있는 경우를 제외해, 정형 처리에서는 복수행이 대상이다고 보여진다.
선택한 폰트가 너무 커 직사각형에 들어가지 않는 경우, 이 메서드는 작은 폰트로 옮겨놓는 처리를 실시하지 않는다.
이 메서드는, escapement 와 orientation 의 양쪽 모두가 제로의 폰트만 지원 한다.