{
  "name": "Canvas",
  "component": "gui",
  "header": "nativeui/gfx/canvas.h",
  "type": "Class",
  "namespace": "nu",
  "description": "Offscreen drawing.",
  "class_methods": [
    {
      "signature": {
        "returnType": {
          "name": "Canvas",
          "id": "canvas"
        },
        "name": "create",
        "parameters": [
          {
            "type": {
              "name": "SizeF",
              "id": "sizef"
            },
            "name": "size"
          },
          {
            "type": {
              "name": "Number"
            },
            "name": "scaleFactor"
          }
        ],
        "shortStr": "create(size, scaleFactor)",
        "str": "create(size, scaleFactor)"
      },
      "description": "Create a new canvas with specified size and scale factor.\n",
      "id": "create-size-scalefactor"
    },
    {
      "signature": {
        "returnType": {
          "name": "Canvas",
          "id": "canvas"
        },
        "name": "createForMainScreen",
        "parameters": [
          {
            "type": {
              "name": "SizeF",
              "id": "sizef"
            },
            "name": "size"
          }
        ],
        "shortStr": "createForMainScreen(size)",
        "str": "createForMainScreen(size)"
      },
      "description": "Create a new canvas with `size` using default scale factor.\n\nThis is strongly discouraged for using, since it does not work well with\nmulti-monitor setup. Only use it when you do not care about per-monitor\nDPI.\n",
      "id": "createformainscreen-size"
    }
  ],
  "methods": [
    {
      "signature": {
        "returnType": {
          "name": "Number"
        },
        "name": "getScaleFactor",
        "parameters": [],
        "shortStr": "getScaleFactor()",
        "str": "getScaleFactor()"
      },
      "description": "Return the scale factor of the canvas.",
      "id": "getscalefactor"
    },
    {
      "signature": {
        "returnType": {
          "name": "Painter",
          "id": "painter"
        },
        "name": "getPainter",
        "parameters": [],
        "shortStr": "getPainter()",
        "str": "getPainter()"
      },
      "description": "Return the Painter that can be used to draw on the canvas.",
      "id": "getpainter"
    },
    {
      "signature": {
        "returnType": {
          "name": "SizeF",
          "id": "sizef"
        },
        "name": "getSize",
        "parameters": [],
        "shortStr": "getSize()",
        "str": "getSize()"
      },
      "description": "Return the DIP size of canvas.",
      "id": "getsize"
    }
  ],
  "module": "gui",
  "id": "canvas"
}