Multi-resolution support
The APIs used in this document are available sincecocos2d-2.0-x-2.0.4.
The diverse set of resolutions on Android devices is hard to adaptto. Cocos2d-x offersCCEGLView::setDesignResolutionSize()
CCDirector::setContentScaleFactor()
The principle
We have removed all the codes relatedto enableRetina
Therefore, you can get the real screen sizeby CCEGLView::sharedOpenGLView()->getFrameSize()
.For example, the function returns '960x640' for Iphone4S inlandscape mode.
But how to use the non-retina coordinates for retina devices? Thereare two concepts you have to know. One isdesignResolutionSize,another is
designResolutionSize
All your game's coordinates rely on design resolution no matterwhat the size of your device screen. If the UI layout of your gameis the same on all resolutions, you just need only a set ofcoordinates. Design resolution is set byCCEGLView::sharedOpenGLView()->setDesignResolutionSize(width,height, policy)
, the first and second parameters are thewidth and height of design resoultion and the third parameter isthe policy you want to use. I will explain the third parameterlater.
You could also use more than one set of resources on differentdevices to make a better display bysearchPath.push_back(largeResource.directory);
,
but you must set the
Here are some code snippets in HelloCpp project.
contentScaleFactor
ContentScaleFactor describes the ratiofrom
For illustration below, we use height to calculate thefactor.
Chart 1:
When using NoBorder mode, there are some areas of the backgroud outof scope. If you use absolute coordinates based on designresolution size(480x320),
some of your game UI will not be shown completely. To resolve thisissue, you have to make the coordinates base on 'visiblerectangle'. You can get the origin point of 'visible rectange' by'CCDirector::sharedDirector()->getVisibleOrign()'.
Together with'CCDirector::sharedDirector()->getVisibleSize()',you will beable to confirm 9 points on the screen. They are 'Left','Right','Top','Bottom','Center','LeftTop','RightTop','LeftBottom' and'RightBottom'.
Your game will be really full screen display if all the coordinatesof your game is base on these ninepoints.
About how to calculate these points, please refer to 'VisibleRect'class in TestCpp project.
Chart 2:
When RH/DH isn't equal to RW/RH, You should decide to select Widthor Height ratio of resource to design resolution.
In the chart 2, we still use height ratio to calculatecontentScaleFator, so the height of the resource background willfill for the height of design resolution.
Mark① shows two black rectangle will be in designresolution.
After mapping design resolution to screen, Mark① --> Mark②, andMark③ will be out of screen.
Now, you have two choices to make your game becomes full screen.One is to make your background picture wider.
Another is to set the contentScaleFactor based on the ratio ofwidth.
Policies
Now cocos2d-x supports five different policies.
Exact fit
The entire application is visible in the specified area withouttrying to preserve the original aspect ratio. Distortion can occur,and the application may appear stretched or compressed.
No border
The entire application fills the specified area, without distortionbut possibly with some cropping, while maintaining the originalaspect ratio of the application.
Show all
The entire application is visible in the specified area withoutdistortion while maintaining the original aspect ratio of theapplication. Borders can appear on two sides of theapplication.
Chart 3:
Mark② and Mark③ are both black rectangle areas. But they aredifferent, Mark③ is out of Opengl Viewport, so you can't put anygame elements onto it.
Mark② appears because RW/RH
Fixed Height
The width parameter of the design resolution size is ignored andrecalculated based on the height of the design resolution and theaspect ratio of the device.
The entire application is visible without distortion. Howeverdevelopers must make sure that they design their UI to matchdifferent aspect ratios.
Using this resolution policy will give you a different window widthacross devices, the window height is fixed. The visibility rectwill start at 0/0.
As you can see the height of the display stays the same on allpossible device resolutions, only the window width will be adjustedto match the device aspect ratio.
In general you can use this mode like the No Boder mode, but thereis no need to use VisibleRect methods. If you place a sprite at(0/0) it will always
be in the lower left corner of the screen, If you place the spriteat (winSize.width/2, winSize.height/2) it will be in the center ofthe screen.
If you place the spite at (winSize.width/0) it will be at the lowerright border of the screen.
Avaiable since cocos2d-x v2.1rc0-x-2.1.3
Fixed Width
This mode works the same as the fixed height mode. The differenceis, that this mode will ignore the height of the design resolutionsize and recalcualte the height depending
on the device aspect ratio.
While the fixed height mode is useful for landscape games, you maywant to prefer this resolution policy for portrait games.
Avaiable since cocos2d-x v2.1rc0-x-2.1.3
- You need to use relative coordinates only inNoBorder, FixedHeight and FixedWidth mode. Generally, developeruses NoBorder mode for better display
External Links
- TBD