add note for perperties on SubContextView component (#9676)

This commit is contained in:
PP
2021-11-18 13:47:05 +08:00
committed by GitHub
parent a076fb496c
commit ae7635be17
+13
View File
@@ -73,6 +73,14 @@ import { CCObject, Texture2D } from '../core';
@requireComponent(UITransform)
@menu('Miscellaneous/SubContextView')
export class SubContextView extends Component {
/**
* @en Specify a reference value of canvas size for style editing in Open Data Context.
* The width and height setting of CSS style should not exceed this size, otherwise the rendered content will exceed the canvas.
* NOTE: This property is read-only at runtime. Please configure the design resolution in the Editor.
*
* @zh 为开放数据域的样式编辑指定一个画布尺寸的参考值,CSS 样式的宽高设置不应该超过这个尺寸,否则渲染的内容会超出画布。
* 注意:该属性在运行时是只读的,请在编辑器环境下配置好设计分辨率。
*/
@tooltip('i18n:subContextView.design_size')
get designResolutionSize () {
return this._designResolutionSize;
@@ -84,6 +92,11 @@ export class SubContextView extends Component {
this._designResolutionSize.set(value);
}
/**
* @en Setting frame rate in Open Data Context.
*
* @zh 设置开放数据域的渲染帧率。
*/
@tooltip('i18n:subContextView.fps')
get fps () {
return this._fps;