X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2FApplicationGuide.md;fp=doc%2FApplicationGuide.md;h=78882922aa3fcef027fdd94da3162d9fa5ad4360;hb=9f9abc58011121722a82759124d061a645cee112;hp=d66f20b4f4f112f3eb47dc51c531d0f2ddf5df3c;hpb=6aaba1066fe89f324d4bae67497f4035fe997d5f;p=apps%2Fagl-service-windowmanager.git diff --git a/doc/ApplicationGuide.md b/doc/ApplicationGuide.md index d66f20b..7888292 100644 --- a/doc/ApplicationGuide.md +++ b/doc/ApplicationGuide.md @@ -517,10 +517,6 @@ This is the public interface of the class `LibWindowmanager`. int activateSurface(json_object *object); int deactivateSurface(json_object *object); int endDraw(json_object *object); - int getDisplayInfo(json_object *object); - int getAreaInfo(json_object *in_obj, json_object *out_obj); - - int getAreaInfo(const char *label, json_object *out_obj); void set_event_handler(enum EventType et, handler_fun f); @@ -584,56 +580,6 @@ It is not crucial to make this call at every time a drawing is finished drawing in case of layout switch. The exact semantics are explained in the next [Events](#_events) Section. -### getDisplayInfo(json_object *object) - -**args: `{ }`** -This function gets the display information as follows: - - width[pixel] - - height[pixel] - - width[mm] - - height[mm] - -It outputs the display information for json_object in the argument as follows: - `{"width_pixel": int value of width[pixel], "height_pixel": int value of height[pixel], - "width_mm": int value of width[mm], "height_mm": int value of height[mm]}` - -It should be called after calling init(). -It should not be called in the event handler because it occurs hang-up. - -#### NOTE -It uses wl_output::geometry() for getting physical width[mm] and height[mm] of the display, -but the value is different with measured value. - - - value from wl_output::geometry(): width:320 height:520 - - measured value : width:193 height:343 - -### getAreaInfo(json_object *in_obj, json_object *out_obj) - -**args1: `{ 'kKeyDrawingName': 'application name' }`** -**args2: `{ }`** -This function gets the information of area drawn by the application as follows: - - x-coordinate - - y-coordinate - - width - - height - -It outputs the area information for json_object in the 2nd argument as follows: - `{"x": int value of x-coordinate, "y": int value of y-coordinate, - "width": int value of width, "height": int value of height}` - -It should be called after calling activateSurface(). -It should not be called in the event handler because it occurs hang-up. - -#### NOTE -The same information can given by SyncDraw event. - -### getAreaInfo(const char *label, json_object *out_obj) - -**args1: String of application name** -**args2: `{ }`** -This function is same with `getAreaInfo(json_object *in_obj, json_object *out_obj)`, -but only has difference of 1st argument. - ### set\_event\_handler(enum EventType et, handler_fun f) This method needs to be used to register event handlers for the WM @@ -759,14 +705,11 @@ contents - again, this is handled implicitly by the wayland protocol. that is *signal* the compositor that its surface contains new content. - `SyncDraw(json_object *object)` - args: { 'kKeyDrawingName': 'application name', 'kKeyDrawingArea': 'layout', - 'kKeyDrawingRect': { "x": int value of x-coordinate, "y": int value of y-coordinate, - "width": int value of width, "height": int value of height } } + args: { 'kKeyDrawingName': 'application name', 'kKeyDrawingArea': 'layout' } Signal applications, that the surface with name `kKeyDrawingArea` needs to redraw its content in the layout with name `kKeyDrawingArea` - this usually is sent when the surface geometry changed. - And the area position and size are included with name `kKeyDrawingRect`. - `FlushDraw(json_object *object)` args: { 'kKeyDrawingName': 'application name' }