{
  "name": "GifPlayer",
  "component": "gui",
  "header": "nativeui/gif_player.h",
  "type": "Class",
  "namespace": "nu",
  "inherit": {
    "name": "View",
    "id": "view"
  },
  "description": "Image view with animated GIF support.",
  "detail": "It can also display other types of images, but only GIF images can be\nanimated.\n\nDisplaying animated GIF images consumes lots of CPU resources, it is highly\nunrecommended to constantly display animated GIF images.\n\nFor optimization, hiding the view would automatically pause the animation,\nand showing the view would automatically resume previous state.\n",
  "class_methods": [
    {
      "signature": {
        "returnType": {
          "name": "GifPlayer",
          "id": "gifplayer"
        },
        "name": "create",
        "parameters": [],
        "shortStr": "create()",
        "str": "create()"
      },
      "description": "Create a new `GifPlayer`.",
      "id": "create"
    }
  ],
  "methods": [
    {
      "signature": {
        "name": "setimage",
        "parameters": [
          {
            "type": {
              "name": "Image",
              "id": "image"
            },
            "name": "image"
          }
        ],
        "shortStr": "setimage(image)",
        "str": "setimage(image)"
      },
      "description": "Set the image.",
      "detail": "After setting the image, the animated image will start playing\nautomatically.\n",
      "id": "setimage-image"
    },
    {
      "signature": {
        "returnType": {
          "name": "Image",
          "id": "image"
        },
        "name": "getimage",
        "parameters": [],
        "shortStr": "getimage()",
        "str": "getimage()"
      },
      "description": "Return the image.",
      "id": "getimage"
    },
    {
      "signature": {
        "name": "setanimating",
        "parameters": [
          {
            "type": {
              "name": "boolean"
            },
            "name": "animating"
          }
        ],
        "shortStr": "setanimating(animating)",
        "str": "setanimating(animating)"
      },
      "description": "Set whether the animated image should be played.",
      "id": "setanimating-animating"
    },
    {
      "signature": {
        "returnType": {
          "name": "boolean"
        },
        "name": "isanimating",
        "parameters": [],
        "shortStr": "isanimating()",
        "str": "isanimating()"
      },
      "description": "Return whether the image is animating.",
      "id": "isanimating"
    },
    {
      "signature": {
        "name": "setscale",
        "parameters": [
          {
            "type": {
              "name": "ImageScale",
              "id": "imagescale"
            },
            "name": "scale"
          }
        ],
        "shortStr": "setscale(scale)",
        "str": "setscale(scale)"
      },
      "description": "Set the scaling mode.",
      "detail": "The default scaling mode is `<!enum class>None`.",
      "id": "setscale-scale"
    },
    {
      "signature": {
        "returnType": {
          "name": "ImageScale",
          "id": "imagescale"
        },
        "name": "getscale",
        "parameters": [],
        "shortStr": "getscale()",
        "str": "getscale()"
      },
      "description": "Return the scaling mode.",
      "id": "getscale"
    }
  ],
  "module": "yue.gui",
  "id": "gifplayer"
}