display_port.md

`ngui/display_port`

`Enum: Orientation`

设置屏幕方向枚举

ORIENTATION_INVALID

ORIENTATION_PORTRAIT

ORIENTATION_LANDSCAPE

ORIENTATION_REVERSE_PORTRAIT

ORIENTATION_REVERSE_LANDSCAPE

ORIENTATION_USER

ORIENTATION_USER_PORTRAIT

ORIENTATION_USER_LANDSCAPE

ORIENTATION_USER_LOCKED

`Enum: StatusBarStyle`

系统状态栏样式枚举

STATUS_BAR_STYLE_WHITE

STATUS_BAR_STYLE_BLACK

`Class DisplayPort`

这个类型的构造函数禁止访问

可以通过app.displayPort或gui.displayPort访问

DisplayPort.onChange

屏幕尺寸变化时触发

DisplayPort.onOrientation

屏幕方向改变时触发

DisplayPort.onRender

一帧渲染完成后触发

DisplayPort.lockSize([width[,height]])

@arg [width=0] {float}
@arg [height=0] {float}

width与height都设置为0时自动设置一个最舒适的默认显示尺寸

设置锁定视口为一个固定的逻辑尺寸,这个值改变时会触发change事件

如果width设置为零表示不锁定宽度,系统会自动根据height值设置一个同等比例的宽度

如果设置为非零表示锁定宽度,不管DisplayPort尺寸怎么变化对于编程者来说,这个值永远保持不变

如果height设置为零表示不锁定,系统会自动根据width值设置一个同等比例的高度

如果设置为非零表示锁定高度,不管DisplayPort尺寸怎么变化对于编程者来说,这个值永远保持不变

DisplayPort.nextFrame(cb)

@arg cb {Function}

Get: DisplayPort.width

{float}

Get: DisplayPort.height

{float}

Get: DisplayPort.phyWidth

屏幕的实际物理像素宽度

{float}

Get: DisplayPort.phyHeight

屏幕的实际物理像素高度

{float}

Get: DisplayPort.bestScale

系统建议的屏幕缩放比

{float}

Get: DisplayPort.scale

当前屏幕缩放比

{float}

Get: DisplayPort.scaleValue

{Vec2}

Get: DisplayPort.rootMatrix

{Mat4}

Get: DisplayPort.atomPixel

屏幕原子像素尺寸

{float}

keepScreen(keep)

保持屏幕，不自动进入休眠状态

@arg keep {bool}

statusBarHeight()

获取系统状态栏高度，在非显示状态会返回0

@ret {float}

setVisibleStatusBar(visible)

设置系统状态栏是否显示

@arg visible {bool}

setStatusBarStyle(style)

设置系统状态栏文本颜色

@arg color {StatusBarStyle}

requestFullscreen(fullscreen)

请求进入全屏或退出全屏状态

@arg fullscreen {bool}

orientation()

返回当前屏幕方向

Returns:
ORIENTATION_PORTRAIT
ORIENTATION_LANDSCAPE
ORIENTATION_REVERSE_PORTRAIT
ORIENTATION_REVERSE_LANDSCAPE
@ret {Orientation} return direction angle

setOrientation(orientation)

设置屏幕旋转方向，应用初始化时为ORIENTATION_USER按当前设备方向自动旋转

@arg orientation {Orientation}

Get: defaultAtomPixel

默认屏幕原子像素尺寸

{float}

Get: atomPixel

屏幕原子像素尺寸

{float}

Get: current

获取当前DisplayPort实例

{DisplayPort}

nextFrame(cb)

渲染下一帧画面后执行回调

Callback: cb()

@arg cb {Function}