View Class

Module: _decorator Parent Module: cc

cc.view is the singleton object which represents the game window.
It's main task include:

  • Apply the design resolution policy
  • Provide interaction with the window, like resize event on web, retina display support, etc...
  • Manage the game view port which can be different with the window
  • Manage the content scale and translation

    Since the cc.view is a singleton, you don't need to call any constructor or create functions,
    the standard way to use it is by calling:
  • cc.view.methodName();

Index

Methods
Events

Details

Methods

setTargetDensityDPI

Sets view's target-densitydpi for android mobile browser. it can be set to:

  1. cc.macro.DENSITYDPI_DEVICE, value is "device-dpi"
  2. cc.macro.DENSITYDPI_HIGH, value is "high-dpi" (default value)
  3. cc.macro.DENSITYDPI_MEDIUM, value is "medium-dpi" (browser's default value)
  4. cc.macro.DENSITYDPI_LOW, value is "low-dpi"
  5. Custom value, e.g: "480"
meta description
Defined in cocos2d/core/platform/CCView.js:237
Deprecated since v2.0
Parameters
getTargetDensityDPI

Returns the current target-densitydpi value of cc.view.

meta description
Returns String
Defined in cocos2d/core/platform/CCView.js:252
Deprecated since v2.0
resizeWithBrowserSize

Sets whether resize canvas automatically when browser's size changed.
Useful only on web.

meta description
Defined in cocos2d/core/platform/CCView.js:261
Parameters
  • enabled Boolean Whether enable automatic resize with browser's resize event
setResizeCallback

Sets the callback function for cc.view's resize action,
this callback will be invoked before applying resolution policy,
so you can do any additional modifications within the callback.
Useful only on web.

meta description
Defined in cocos2d/core/platform/CCView.js:288
Parameters
  • callback Function | Null The callback function
setOrientation

Sets the orientation of the game, it can be landscape, portrait or auto. When set it to landscape or portrait, and screen w/h ratio doesn't fit, cc.view will automatically rotate the game canvas using CSS. Note that this function doesn't have any effect in native, in native, you need to set the application orientation in native project settings

meta description
Defined in cocos2d/core/platform/CCView.js:307
Parameters
  • orientation Number Possible values: cc.macro.ORIENTATION_LANDSCAPE | cc.macro.ORIENTATION_PORTRAIT | cc.macro.ORIENTATION_AUTO
adjustViewportMeta

Sets whether the engine modify the "viewport" meta in your web page.
It's enabled by default, we strongly suggest you not to disable it.
And even when it's enabled, you can still set your own "viewport" meta, it won't be overridden
Only useful on web

meta description
Defined in cocos2d/core/platform/CCView.js:422
Parameters
  • enabled Boolean Enable automatic modification to "viewport" meta
enableRetina

Retina support is enabled by default for Apple device but disabled for other devices,
it takes effect only when you called setDesignResolutionPolicy
Only useful on web

meta description
Defined in cocos2d/core/platform/CCView.js:439
Parameters
  • enabled Boolean Enable or disable retina display
isRetinaEnabled

Check whether retina display is enabled.
Only useful on web

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCView.js:454
enableAntiAlias

Whether to Enable on anti-alias

meta description
Defined in cocos2d/core/platform/CCView.js:467
Parameters
  • enabled Boolean Enable or not anti-alias
isAntiAliasEnabled

Returns whether the current enable on anti-alias

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCView.js:501
enableAutoFullScreen

If enabled, the application will try automatically to enter full screen mode on mobile devices
You can pass true as parameter to enable it and disable it by passing false.
Only useful on web

meta description
Defined in cocos2d/core/platform/CCView.js:510
Parameters
  • enabled Boolean Enable or disable auto full screen on mobile devices
isAutoFullScreenEnabled

Check whether auto full screen is enabled.
Only useful on web

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCView.js:534
getCanvasSize

Returns the canvas size of the view.
On native platforms, it returns the screen size since the view is a fullscreen view.
On web, it returns the size of the canvas element.

meta description
Returns Size
Defined in cocos2d/core/platform/CCView.js:571
getFrameSize

Returns the frame size of the view.
On native platforms, it returns the screen size since the view is a fullscreen view.
On web, it returns the size of the canvas's outer DOM element.

meta description
Returns Size
Defined in cocos2d/core/platform/CCView.js:586
setFrameSize

On native, it sets the frame size of view.
On web, it sets the size of the canvas's outer DOM element.

meta description
Defined in cocos2d/core/platform/CCView.js:601
Parameters
getVisibleSize

Returns the visible area size of the view port.

meta description
Returns Size
Defined in cocos2d/core/platform/CCView.js:619
getVisibleSizeInPixel

Returns the visible area size of the view port.

meta description
Returns Size
Defined in cocos2d/core/platform/CCView.js:630
getVisibleOrigin

Returns the visible origin of the view port.

meta description
Returns Vec2
Defined in cocos2d/core/platform/CCView.js:642
getVisibleOriginInPixel

Returns the visible origin of the view port.

meta description
Returns Vec2
Defined in cocos2d/core/platform/CCView.js:653
getResolutionPolicy

Returns the current resolution policy

meta description
Returns ResolutionPolicy
Defined in cocos2d/core/platform/CCView.js:665
setResolutionPolicy

Sets the current resolution policy

meta description
Defined in cocos2d/core/platform/CCView.js:677
Parameters
setDesignResolutionSize

Sets the resolution policy with designed view size in points.
The resolution policy include:
[1] ResolutionExactFit Fill screen by stretch-to-fit: if the design resolution ratio of width to height is different from the screen resolution ratio, your game view will be stretched.
[2] ResolutionNoBorder Full screen without black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two areas of your game view will be cut.
[3] ResolutionShowAll Full screen with black border: if the design resolution ratio of width to height is different from the screen resolution ratio, two black borders will be shown.
[4] ResolutionFixedHeight Scale the content's height to screen's height and proportionally scale its width
[5] ResolutionFixedWidth Scale the content's width to screen's width and proportionally scale its height
[cc.ResolutionPolicy] [Web only feature] Custom resolution policy, constructed by cc.ResolutionPolicy

meta description
Defined in cocos2d/core/platform/CCView.js:706
Parameters
getDesignResolutionSize

Returns the designed size for the view. Default resolution size is the same as 'getFrameSize'.

meta description
Returns Size
Defined in cocos2d/core/platform/CCView.js:786
setRealPixelResolution

Sets the container to desired pixel resolution and fit the game content to it. This function is very useful for adaptation in mobile browsers. In some HD android devices, the resolution is very high, but its browser performance may not be very good. In this case, enabling retina display is very costy and not suggested, and if retina is disabled, the image may be blurry. But this API can be helpful to set a desired pixel resolution which is in between. This API will do the following:

1. Set viewport's width to the desired width in pixel
2. Set body width to the exact pixel resolution
3. The resolution policy will be reset with designed view size in points.
meta description
Defined in cocos2d/core/platform/CCView.js:799
Parameters
setViewportInPoints

Sets view port rectangle with points.

meta description
Defined in cocos2d/core/platform/CCView.js:832
Deprecated since v2.0
Parameters
setScissorInPoints

Sets Scissor rectangle with points.

meta description
Defined in cocos2d/core/platform/CCView.js:851
Deprecated since v2.0
Parameters
isScissorEnabled

Returns whether GL_SCISSOR_TEST is enable

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCView.js:884
Deprecated since v2.0
getScissorRect

Returns the current scissor rectangle

meta description
Returns Rect
Defined in cocos2d/core/platform/CCView.js:896
Deprecated since v2.0
getViewportRect

Returns the view port rectangle.

meta description
Returns Rect
Defined in cocos2d/core/platform/CCView.js:919
getScaleX

Returns scale factor of the horizontal direction (X axis).

meta description
Returns Number
Defined in cocos2d/core/platform/CCView.js:930
getScaleY

Returns scale factor of the vertical direction (Y axis).

meta description
Returns Number
Defined in cocos2d/core/platform/CCView.js:941
getDevicePixelRatio

Returns device pixel ratio for retina display.

meta description
Returns Number
Defined in cocos2d/core/platform/CCView.js:952
convertToLocationInView

Returns the real location in view for a translation based on a related position

meta description
Returns Vec2
Defined in cocos2d/core/platform/CCView.js:963
Parameters
  • tx Number The X axis translation
  • ty Number The Y axis translation
  • relatedPos Object The related position object including "left", "top", "width", "height" informations

Events

design-resolution-changed Event

Module: _decorator Parent Module: cc

!en Emit when design resolution changed. !zh 当设计分辨率改变时发送。

Index

Details

canvas-resize Event

Module: _decorator Parent Module: cc

!en Emit when canvas resize. !zh 当画布大小改变时发送。

Index

Details

results matching ""

    No results matching ""