API 레퍼런스
검색 색인 준비 중…

하나의 sfml.js 렌더 창에 바인딩된 RmlUi 컨텍스트입니다.

등록 인스턴스는 createContext, 독립 소유 인스턴스는 Factory.instanceContext로 얻습니다. 컨텍스트는 연결한 문서를 소유하며, Context.remove 또는 shutdown 후에는 관련 래퍼를 사용할 수 없습니다.

상속 관계

계층 (요약 보기)

소스와 상속
멤버 목록62

생성자

접근자

메소드

생성자

  • 독립 소유 네이티브 Rml::Context를 생성합니다.

    매개변수

    name
    string

    Core 등록과 독립적인 네이티브 이름입니다.

    manager

    컨텍스트가 유지하는 유효 네이티브 렌더 관리자입니다.

    handler

    명시적 대여 텍스트 입력 처리기 또는 null입니다.

    반환값

    크기 0과 밀도 1을 유지하며 Core 등록 및 플러그인 알림을 수행하지 않습니다. remove 또는 수거까지 관리자를 유지합니다. 명시적 null은 전역 처리기를 선택하지 않습니다. ContextInstancer 콜백에서도 사용할 수 있습니다.

    소스와 상속

접근자

  • get densityIndependentPixelRatio(): number

    RCSS dp당 물리 픽셀 수입니다.

    반환값

    number

    현재 표시 밀도입니다.

    Rml::Context::GetDensityIndependentPixelRatio()에 해당합니다. 자동 모드에서는 생성, 갱신, 크기 변경 시 동기화하며 수동 값은 null로 해제합니다.

    소스와 상속
  • get dimensions(): ContextDimensions

    네이티브 공유 메모리에서 캐시된 크기를 읽습니다.

    반환값

    물리 픽셀 단위의 캐시된 너비와 높이 뷰입니다.

    같은 뷰에 setDimensions()와 전달된 크기 변경 이벤트가 반영됩니다. 레이아웃 변경에는 Context.setDimensions를 사용하세요. 설정자는 없으며 컨텍스트 파괴 후 유지된 뷰는 0이 됩니다.

    소스와 상속
  • get isMouseInteracting(): boolean

    불투명도와 무관한 현재 Rml::Context::IsMouseInteracting 힌트입니다.

    반환값

    boolean

    요소가 호버, 활성 또는 자동 스크롤 상태인지 여부입니다.

    소스와 상속
  • get name(): string

    런타임 세대를 검증한 Rml::Context::GetName입니다.

    반환값

    string

    컨텍스트 이름입니다.

    소스와 상속
  • get renderInterface(): RenderInterface

    이 컨텍스트의 네이티브 렌더 관리자가 사용하는 렌더 인터페이스입니다.

    반환값

    리소스 작업 범위를 지정하는 고유 렌더 인터페이스 참조입니다.

    소스와 상속

메소드

  • Rml::Context::ActivateTheme으로 이름 있는 RCSS 미디어 테마를 전환합니다.

    매개변수

    name
    string

    @media (theme: name)에 사용할 테마 이름입니다.

    activate
    boolean

    true이면 활성화하고 false이면 비활성화합니다.

    반환값

    void
    소스와 상속
  • Rml::Context::AddEventListener처럼 루트에 등록합니다.

    매개변수

    type
    string | number

    이벤트 이름 또는 등록된 EventId입니다.

    listener

    동기 콜백입니다.

    capture
    boolean = false

    캡처 플래그이며 기본값은 false입니다.

    반환값

    void
    소스와 상속
  • Rml::Context::CreateDocument로 빈 문서를 만듭니다.

    매개변수

    instancerName
    string = 'body'

    등록된 문서 인스턴서 이름이며 기본값은 "body"입니다.

    반환값

    null | Document

    컨텍스트가 소유하는 문서이며 팩토리 실패 시 null입니다.

    소스와 상속
  • RmlUi의 마우스 커서 제어를 전환합니다.

    매개변수

    enable
    boolean

    true이면 RmlUi가 시스템 커서를 제어합니다.

    반환값

    void

    활성화하면 다음 마우스 갱신에서 동기화합니다. 비활성화해도 커서를 숨기지 않습니다.

    소스와 상속
  • Rml::Context::GetDocument의 두 오버로드로 문서를 찾습니다.

    매개변수

    idOrIndex
    string | number

    문서 id 또는 스택 순서의 0부터 시작하는 int32 인덱스입니다.

    반환값

    null | Document

    첫 번째 일치 문서이며 id가 없거나 범위 밖이면 null입니다.

    소스와 상속
  • 이후 문서 생성에 사용하는 루트 태그를 가져옵니다.

    반환값

    string

    이후 문서에 사용할 루트 태그입니다.

    소스와 상속
  • Rml::Context::GetElementAtPoint로 현재 레이아웃을 히트 테스트합니다.

    매개변수

    point

    물리 픽셀 좌표로 float 반올림 후 int32 범위 안이어야 합니다.

    ignoreElement
    null | Element = null

    무시할 하위 트리이며 기본값은 null입니다.

    element
    null | Element = null

    네이티브 검색 루트이며 null은 컨텍스트 루트입니다.

    반환값

    null | Element

    가장 깊은 히트 요소 또는 null이며 요소 인수는 이 컨텍스트에 속해야 합니다.

    변환 행렬은 render()에서 갱신됩니다. 마지막 렌더링 행렬을 사용하며, 클리핑은 역투영 좌표와 조상의 클립 사각형을 비교합니다.

    소스와 상속
  • 현재 입력 포커스를 가진 요소를 가져옵니다.

    반환값

    null | Element

    포커스 요소로 루트일 수도 있으며 없으면 null입니다.

    소스와 상속
  • 최근 입력 또는 갱신 후 포인터 아래 요소를 가져옵니다.

    반환값

    null | Element

    최근 입력 또는 갱신에 따른 호버 요소이며 없으면 null입니다.

    소스와 상속
  • 다음 예정 컨텍스트 갱신까지의 초를 가져옵니다.

    반환값

    number

    갱신까지 남은 초이며 Infinity는 네이티브 갱신 기한이 없음을 뜻합니다.

    소스와 상속
  • Rml::Context::GetNumDocuments로 로드된 문서 수를 셉니다.

    반환값

    number

    파괴 대기 문서를 제외한 수입니다.

    소스와 상속
  • 이 렌더 인터페이스를 사용하는 컨텍스트의 공유 렌더 관리자를 가져옵니다.

    반환값

    같은 렌더 인터페이스의 컨텍스트가 공유하는 관리자입니다.

    소스와 상속
  • Rml::Context::GetRootElement를 고유 요소 래퍼로 반환합니다.

    반환값

    컨텍스트 파괴 전까지 유효한 루트 요소입니다.

    소스와 상속
  • 등록된 네이티브 Context 스크립트를 읽습니다.

    반환값

    null | object

    같은 등록 호스트이며 미등록 시 null입니다.

    소스와 상속
  • Rml::Context::IsThemeActive로 테마 상태를 조회합니다.

    매개변수

    name
    string

    테마 이름입니다.

    반환값

    boolean

    테마의 활성화 여부입니다.

    소스와 상속
  • 외부 .rml 문서 또는 네이티브 스트림의 현재 커서에서 로드합니다.

    매개변수

    documentPath
    string | Stream

    파일 인터페이스 경로 또는 원본 URL이 있는 스트림입니다.

    반환값

    로드된 숨김 상태 문서이며 show()로 표시합니다.

    로드 실패 시 Error입니다.

    소스와 상속
  • RML 문자열을 문서로 파싱합니다.

    매개변수

    rml
    string

    RML 마크업입니다.

    sourceUrl선택 사항
    string

    상대 리소스 해석에 사용할 선택적 소스 URL입니다.

    반환값

    파싱된 숨김 상태 문서이며 show()로 표시합니다.

    생략하면 "[document from memory]"를 쓰고 빈 문자열은 유지합니다. RmlUi는 head 해석 시 sourceURL을 기록하여 상대 리소스 경로를 해석합니다. 문자열이 아닌 값과 널 문자는 거부됩니다.

    파싱 실패 시 Error입니다.

    소스와 상속
  • sfml.js 창 이벤트를 RmlUi에 전달합니다.

    매개변수

    event
    Event<(keyof EventPayloads)> | EventData

    sfml.js 이벤트 객체 또는 이벤트 데이터입니다.

    반환값

    boolean

    상위 라이브러리의 전파 또는 상호작용 결과입니다. 무시한 이벤트는 true입니다.

    키·텍스트·휠은 전파 상태, 마우스·터치는 요소와 상호작용하지 않는지 반환합니다. 좌표는 물리 픽셀입니다. 키 보조 키는 이벤트 스냅샷, 포인터 보조 키는 현재 상태입니다. 터치는 항목 하나의 TouchList로 전달합니다. 시스템 키는 macOS에서 LMETA/RMETA, 다른 플랫폼에서 LWIN/RWIN입니다. TextEntered는 CR을 LF로 바꾸고 다른 제어 문자를 건너뜁니다. 크기 변경 시 크기와 밀도를 갱신합니다.

    소스와 상속
  • KeyIdentifier 또는 사용자 키(177–250)로 Rml::Context::ProcessKeyDown을 호출합니다.

    매개변수

    key
    number

    SFML 키 코드와 다른 RmlUi 키 식별자입니다.

    modifiers
    number = 0

    KeyModifier 플래그의 비트 OR이며 기본값은 0입니다.

    반환값

    boolean

    이벤트 전파가 계속되는지 여부입니다.

    소스와 상속
  • Rml::Context::ProcessKeyUp을 호출합니다.

    매개변수

    key
    number

    RmlUi KeyIdentifier 또는 사용자 키(177–250)입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    이벤트 전파가 계속되는지 여부입니다.

    소스와 상속
  • 마지막 마우스 위치에서 Rml::Context::ProcessMouseButtonDown을 호출합니다.

    매개변수

    button
    number

    음수가 아닌 버튼 번호입니다. 왼쪽 0, 오른쪽 1, 가운데 2입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    마우스가 요소와 상호작용하지 않으면 true입니다.

    소스와 상속
  • 마지막 마우스 위치에서 Rml::Context::ProcessMouseButtonUp을 호출합니다.

    매개변수

    button
    number

    음수가 아닌 버튼 번호입니다. 왼쪽 0, 오른쪽 1, 가운데 2입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    마우스가 요소와 상호작용하지 않으면 true입니다.

    소스와 상속
  • Rml::Context::ProcessMouseLeave로 다음 이동까지 호버를 해제합니다.

    반환값

    boolean

    마우스가 요소와 상호작용하지 않으면 true입니다.

    소스와 상속
  • 창의 물리 픽셀로 Rml::Context::ProcessMouseMove를 호출합니다.

    매개변수

    x
    number

    부호 있는 32비트 가로 좌표입니다.

    y
    number

    부호 있는 32비트 세로 좌표입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    마우스가 요소와 상호작용하지 않으면 true입니다.

    소스와 상속
  • Rml::Context::ProcessMouseWheel을 호출합니다.

    매개변수

    delta

    양수가 오른쪽과 아래인 휠 벡터입니다. 숫자는 사용 중단된 수직 오버로드입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    이벤트 전파가 계속되는지 여부입니다.

    소스와 상속
  • Rml::Context::ProcessTextInput으로 Unicode 텍스트를 입력합니다.

    매개변수

    text
    string | number

    문자열 또는 Unicode 스칼라 값입니다. 단독 서로게이트는 거부합니다.

    반환값

    boolean

    이벤트 전파가 계속되는지 여부입니다.

    문자열은 textinput 이벤트 하나를 생성하며 숫자는 문자 오버로드를 사용합니다. 직접 입력은 제어 문자를 유지합니다.

    소스와 상속
  • 한 바이트로 Rml::Context::ProcessTextInput(char)를 호출합니다.

    매개변수

    byte
    number

    0부터 255까지의 정수입니다.

    반환값

    boolean

    이벤트 전파가 계속되는지 여부이며 상위 바이트는 false를 반환합니다.

    ASCII 바이트 0–127은 제어 문자를 유지하며 128–255는 네이티브 char와 동일하게 이벤트를 생성하지 않습니다. Unicode는 processTextInput을 사용합니다.

    소스와 상속
  • Rml::Context::ProcessTouchCancel로 터치를 취소합니다.

    매개변수

    touches
    readonly Touch[]

    순서가 있는 터치 목록입니다.

    반환값

    boolean

    결과의 논리 AND입니다. 알 수 없는 터치는 false, 빈 목록은 true입니다.

    RmlUi 6.3은 보조 키 없는 왼쪽 버튼 해제를 모방하며 클릭이 발생할 수 있습니다.

    소스와 상속
  • Rml::Context::ProcessTouchEnd로 모든 터치를 해제합니다.

    매개변수

    touches
    readonly Touch[]

    순서가 있는 터치 목록입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    결과의 논리 AND입니다. 알 수 없는 터치와 빈 목록은 true입니다.

    소스와 상속
  • Rml::Context::ProcessTouchMove로 모든 터치를 이동합니다.

    매개변수

    touches
    readonly Touch[]

    순서가 있는 터치 목록입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    결과의 논리 AND입니다. 알 수 없는 터치와 빈 목록은 true입니다.

    소스와 상속
  • Rml::Context::ProcessTouchStart로 모든 터치를 시작합니다.

    매개변수

    touches
    readonly Touch[]

    전체 검증 후 순서대로 처리하는 터치 목록입니다.

    modifiers
    number = 0

    KeyModifier 플래그이며 기본값은 0입니다.

    반환값

    boolean

    상위 라이브러리 상호작용 결과의 논리 AND입니다. 빈 목록은 true입니다.

    소스와 상속
  • Rml::Context::PullDocumentToFront로 문서를 맨 앞으로 이동합니다.

    매개변수

    document

    이 컨텍스트에 속한 문서입니다.

    반환값

    void
    소스와 상속
  • Rml::Context::PushDocumentToBack으로 문서를 맨 뒤로 이동합니다.

    매개변수

    document

    이 컨텍스트에 속한 문서입니다.

    반환값

    void
    소스와 상속
  • 원래 생성기를 통해 독립 소유 Context를 해제합니다.

    반환값

    void

    등록 컨텍스트는 release를 거부합니다. remove()로 등록을 제거하세요.

    소스와 상속
  • RmlUi에서 이 컨텍스트를 제거합니다.

    반환값

    boolean

    네이티브 컨텍스트를 제거했는지 여부입니다.

    등록 컨텍스트는 Rml::RemoveContext, 독립 소유는 네이티브 소유권을 해제합니다. 같은 이름의 등록은 제거하지 않고 리스너를 자동 해제합니다. remove 재호출을 포함한 이후 작업은 예외를 던집니다. 크기는 0이 되며 같은 이름으로 다시 생성해도 복구되지 않습니다.

    소스와 상속
  • Rml::Context::RemoveDataModel을 실행하고 모든 수명 핸들을 무효화합니다.

    매개변수

    name
    string

    모델 이름입니다.

    반환값

    boolean

    네이티브 삭제 결과입니다.

    소스와 상속
  • 일치하는 컨텍스트 루트 등록을 제거합니다.

    매개변수

    type
    string | number

    이벤트 이름 또는 등록된 EventId입니다.

    listener

    등록된 콜백입니다.

    capture
    boolean = false

    등록 시 캡처 플래그이며 기본값은 false입니다.

    반환값

    void
    소스와 상속
  • 이번 프레임의 지오메트리를 컴파일하고 제출합니다.

    반환값

    boolean

    네이티브 렌더링 결과이며 현재는 항상 true입니다.

    RmlUi 6.3의 Rml::Context::Render는 지오메트리가 없어도 true를 반환합니다. 호출 전에 sfml.js 그리기 큐를 flush하고 이후 display()로 표시하세요. 창 뷰와 클립 영역이 변경됩니다. 매 프레임 장면 그리기를 기록하기 전에 window.setView(sceneView)로 장면 뷰를 다시 설정하세요.

    소스와 상속
  • 음이 아닌 초 단위 지연 후 RmlUi 갱신을 요청합니다.

    매개변수

    delay
    number

    초 단위이며 0과 Infinity를 허용합니다.

    반환값

    void

    Rml::Context::RequestNextUpdate에 해당하며 지연만 줄입니다. update()가 재설정한 후 네이티브 요소가 다음 갱신을 요청합니다.

    소스와 상속
  • 이 컨텍스트의 기본 스크롤 동작과 속도를 설정합니다.

    매개변수

    behavior

    기본 스크롤 동작이며 Auto는 Smooth를 사용합니다.

    speedFactor
    number = 1

    양의 유한 float이며 기본값은 1입니다.

    반환값

    void
    소스와 상속
  • Rml::Context::SetDensityIndependentPixelRatio를 설정하거나 자동으로 복원합니다.

    매개변수

    ratio
    null | number

    양의 유한 비율이며 null은 창 동기화를 복원합니다.

    반환값

    void
    소스와 상속
  • 일반적으로 창 크기 변경 시 컨텍스트 크기를 갱신합니다.

    매개변수

    width
    number

    Rml::Context::SetDimensions에 전달할 물리 픽셀 너비입니다.

    height
    number

    물리 픽셀 높이입니다.

    반환값

    void
    소스와 상속
  • Rml::Context::SetDocumentsBaseTag로 이후 문서의 루트 태그를 설정합니다.

    매개변수

    tag
    string

    루트 태그이며 초기값은 "body"입니다.

    반환값

    void
    소스와 상속
  • 이후 로드의 문서 스크립트 호스트를 선택하거나 비활성화합니다.

    매개변수

    host

    캡처된 호스트이며 null은 일반 RmlUi 문서를 사용합니다.

    반환값

    void

    기존 문서는 호스트를 유지하며 전역 body/리스너 등록을 보존합니다. 활성 네이티브 콜백에서는 변경할 수 없습니다.

    소스와 상속
  • Context의 기존 소유권으로 스크립트를 등록합니다.

    매개변수

    object
    null | object

    호스트 객체이며 null은 연결을 해제합니다.

    반환값

    void

    등록 컨텍스트는 네이티브가 유지합니다. 독립 소유는 JS 소유자 연결을 사용하여 컨텍스트와 객체의 순환을 수집할 수 있습니다.

    소스와 상속
  • Rml::Context::UnfocusDocument로 이전 문서의 포커스를 복원합니다.

    매개변수

    document

    이 컨텍스트의 포커스 기록에서 제거할 문서입니다.

    반환값

    void
    소스와 상속
  • Rml::Context::UnloadAllDocuments로 모든 문서의 파괴를 예약합니다.

    반환값

    void
    소스와 상속
  • Rml::Context::UnloadDocument로 문서 파괴를 예약합니다.

    매개변수

    document

    이 컨텍스트에 속한 문서입니다.

    반환값

    void

    unload를 동기 전달한 뒤 조회에서 제외하고 update에서 파괴합니다. 예약된 문서는 무시합니다.

    소스와 상속
  • 이번 프레임의 레이아웃과 이벤트 처리를 실행합니다.

    반환값

    boolean

    네이티브 갱신 결과이며 현재는 항상 true입니다.

    RmlUi 6.3의 Rml::Context::Update는 항상 true를 반환하며 활성 상태가 아닙니다. 입력이 없어도 매 프레임 render() 전에 호출하세요.

    소스와 상속

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0