docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class CompressedImageMsg

    ROS sensor_msgs/CompressedImage message.

    Inheritance
    object
    CompressedImageMsg
    Implements
    IMessage
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.SimulationPro.Foundation.SensorMessages
    Assembly: Unity.SimulationPro.Foundation.dll
    Syntax
    [Serializable]
    public class CompressedImageMsg : IMessage

    Constructors

    CompressedImageMsg()

    Compressed image buffer

    Declaration
    public CompressedImageMsg()

    CompressedImageMsg(HeaderMsg, string, byte[])

    Initializes a new instance with default values.

    Declaration
    public CompressedImageMsg(HeaderMsg header, string format, byte[] data)
    Parameters
    Type Name Description
    HeaderMsg header

    ROS message header containing timestamp and coordinate frame identifier.

    string format

    Compression or encoding format string.

    byte[] data

    The payload data for this message.

    Fields

    data

    Specifies the format of the data Acceptable values: jpeg, png

    Declaration
    public byte[] data
    Field Value
    Type Description
    byte[]

    format

    Header timestamp should be acquisition time of image Header frame_id should be optical frame of camera origin of frame should be optical center of cameara +x should point to the right in the image +y should point down in the image +z should point into to plane of the image

    Declaration
    public string format
    Field Value
    Type Description
    string

    header

    This message contains a compressed image.

    Declaration
    public HeaderMsg header
    Field Value
    Type Description
    HeaderMsg

    k_MessageTypeId

    Identifier for this message type.

    Declaration
    public static readonly MessageTypeId k_MessageTypeId
    Field Value
    Type Description
    MessageTypeId

    k_MessageTypeName

    The ROS message type name string used for serialization and topic matching.

    Declaration
    public const string k_MessageTypeName = "sensor_msgs/CompressedImage"
    Field Value
    Type Description
    string

    Properties

    MessageTypeId

    Gets the unique runtime identifier for this message type.

    Declaration
    public MessageTypeId MessageTypeId { get; }
    Property Value
    Type Description
    MessageTypeId

    MessageTypeName

    Gets the ROS message type name for this message.

    Declaration
    public string MessageTypeName { get; }
    Property Value
    Type Description
    string

    Methods

    Deserialize(IMessageDeserializer)

    Deserializes a CompressedImageMsg from the given deserializer.

    Declaration
    public static CompressedImageMsg Deserialize(IMessageDeserializer deserializer)
    Parameters
    Type Name Description
    IMessageDeserializer deserializer

    The deserializer.

    Returns
    Type Description
    CompressedImageMsg

    A new CompressedImageMsg instance.

    Register()

    Registers this message type with the MessageTypeRegistry.

    Declaration
    [InitializeOnLoadMethod]
    public static void Register()

    ToString()

    Returns a human-readable string representation of this message.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of this instance.

    Overrides
    object.ToString()

    WriteTo(IMessageSerializer)

    Serializes this message to the given serializer.

    Declaration
    public void WriteTo(IMessageSerializer serializer)
    Parameters
    Type Name Description
    IMessageSerializer serializer

    The serializer.

    Implements

    IMessage

    Extension Methods

    MessageExtensions.ToTexture2D(CompressedImageMsg)
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)