抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 基础
  • 渲染
  • 字体
  • 帧率
  • 图片
  • 资源压缩
  • 光标样式
  • tt.isPointerLocked
  • tt.exitPointerLock
  • tt.setCursor
  • tt.requestPointerLock
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.setCursor
    收藏
    我的收藏

    基础库 3.54.0 开始支持本方法,这是一个同步方法。

    修改鼠标光标,仅支持 PC 平台

    前提条件
    业务背景
    使用限制

    只支持 PC 端使用该能力

    注意事项
    相关教程

    语法

    tt.setCursor(path, x, y)

    参数说明

    path

    类型默认值必填说明最低支持版本
    string

    指定光标:

    • 支持自定义图片和关键字(参考 CSS 标准
    • 图片文件可选 ttfile:// 文件路径或者代码包路径
    • 图片文件支持 ico 和 cur 格式,推荐图标大小 32x32
    • 传入 'default' 代表恢复系统默认
    3.54.0

    x

    类型默认值必填说明最低支持版本
    number

    横向偏移量,只有自定义文件光标有效

    3.54.0

    y

    类型默认值必填说明最低支持版本
    number

    纵向偏移量,只有自定义文件光标有效

    3.54.0

    返回值

    类型说明最低支持版本
    boolean

    接口调用是否成功;

    光标设置成功受图片格式和大小影响,需要预览验证;

    3.54.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    999999invalid paramD

    参数错误

    3.54.0
    999988The feature is not available in current operating systemD

    不支持该系统,只支持在 PC 端调用

    3.54.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例

    开发者工具中预览

    // 默认图标 tt.setCursor('default'); // CSS 标准支持图标 tt.setCursor('copy'); // 指定文件 tt.setCursor('xxx.ico', 10, 10);