node-ctypes - v2.10.0
    Preparing search index...

    Interface SimpleCDataConstructor<Tag>

    Constructor interface for simple C data types (c_int, c_float, etc.).

    Each type class has a static _size (byte size) and _type (CType identifier), and instances hold a value in a buffer.

    interface SimpleCDataConstructor<Tag extends string = string> {
        new SimpleCDataConstructor(
            value?: any,
        ): SimpleCDataInstance<JsFromTag<Tag>>;
        _size: number;
        _type: number;
        from_buffer<T extends SimpleCDataConstructor<Tag>>(
            this: T,
            buffer: ArrayBufferView<ArrayBufferLike> | { _buffer: Buffer },
            offset?: number,
        ): InstanceType<T>;
        from_buffer_copy<T extends SimpleCDataConstructor<Tag>>(
            this: T,
            buffer: ArrayBufferView<ArrayBufferLike> | { _buffer: Buffer },
            offset?: number,
        ): InstanceType<T>;
        from_address<T extends SimpleCDataConstructor<Tag>>(
            this: T,
            address: number | bigint,
        ): InstanceType<T>;
        in_dll<T extends SimpleCDataConstructor<Tag>>(
            this: T,
            library: Library | CDLL,
            name: string,
        ): InstanceType<T>;
    }

    Type Parameters

    • Tag extends string = string
    Index
    constructor
    _size _type
    from_buffer from_buffer_copy from_address in_dll

    Readonly_size

    _size: number

    Size of this type in bytes.

    Readonly_type

    _type: number

    CType numeric identifier.

    • Create an instance that aliases an existing Buffer (zero-copy).

      Type Parameters

      Parameters

      • this: T
      • buffer: ArrayBufferView<ArrayBufferLike> | { _buffer: Buffer }
      • Optionaloffset: number

      Returns InstanceType<T>

    • Create an instance whose buffer is a copy of the source bytes.

      Type Parameters

      Parameters

      • this: T
      • buffer: ArrayBufferView<ArrayBufferLike> | { _buffer: Buffer }
      • Optionaloffset: number

      Returns InstanceType<T>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods