Class ImageFormatData


  • public class ImageFormatData
    extends CFacade
    Generated facet for DNA struct type 'ImageFormatData'.

    Class Documentation

    Blender Source Code


    Generic image format settings, this is used for NodeImageFile and IMAGE_OT_save_as operator too.

    note: its a bit strange that even though this is an image format struct the imtype can still be used to select video formats. RNA ensures these enum's are only selectable for render output.

    • Field Detail

      • __DNA__SDNA_INDEX

        public static final int __DNA__SDNA_INDEX
        This is the sdna index of the struct ImageFormatData.

        It is required when allocating a new block to store data for ImageFormatData.

        See Also:
        StructDNA, BlockTable, Constant Field Values
      • __DNA__FIELD__imtype

        public static final long[] __DNA__FIELD__imtype
        Field descriptor (offset) for struct member 'imtype'.

        Field Documentation

        Blender Source Code

        R_IMF_IMTYPE_PNG, R_...

        Note

        Video types should only ever be set from this structure when used from RenderData .

        Video types should only ever be set from this structure when used from RenderData.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__imtype);
         CPointer<Byte> p_imtype = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'imtype'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__depth

        public static final long[] __DNA__FIELD__depth
        Field descriptor (offset) for struct member 'depth'.

        Field Documentation

        Blender Source Code

        bits per channel, R_IMF_CHAN_DEPTH_8 -> 32, not a flag, only set 1 at a time.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__depth);
         CPointer<Byte> p_depth = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'depth'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__planes

        public static final long[] __DNA__FIELD__planes
        Field descriptor (offset) for struct member 'planes'.

        Field Documentation

        Blender Source Code

        R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__planes);
         CPointer<Byte> p_planes = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'planes'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__flag

        public static final long[] __DNA__FIELD__flag
        Field descriptor (offset) for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Generic options for all image types, alpha zbuffer.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__flag);
         CPointer<Byte> p_flag = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__quality

        public static final long[] __DNA__FIELD__quality
        Field descriptor (offset) for struct member 'quality'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: jpeg quality.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__quality);
         CPointer<Byte> p_quality = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'quality'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__compress

        public static final long[] __DNA__FIELD__compress
        Field descriptor (offset) for struct member 'compress'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: png compression.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__compress);
         CPointer<Byte> p_compress = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'compress'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__exr_codec

        public static final long[] __DNA__FIELD__exr_codec
        Field descriptor (offset) for struct member 'exr_codec'.

        Field Documentation

        Blender Source Code

        format specific OpenEXR

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__exr_codec);
         CPointer<Byte> p_exr_codec = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'exr_codec'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__cineon_flag

        public static final long[] __DNA__FIELD__cineon_flag
        Field descriptor (offset) for struct member 'cineon_flag'.

        Field Documentation

        Blender Source Code

        Cineon

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__cineon_flag);
         CPointer<Byte> p_cineon_flag = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'cineon_flag'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__cineon_white

        public static final long[] __DNA__FIELD__cineon_white
        Field descriptor (offset) for struct member 'cineon_white'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__cineon_white);
         CPointer<Short> p_cineon_white = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'cineon_white'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__cineon_black

        public static final long[] __DNA__FIELD__cineon_black
        Field descriptor (offset) for struct member 'cineon_black'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__cineon_black);
         CPointer<Short> p_cineon_black = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'cineon_black'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__cineon_gamma

        public static final long[] __DNA__FIELD__cineon_gamma
        Field descriptor (offset) for struct member 'cineon_gamma'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__cineon_gamma);
         CPointer<Float> p_cineon_gamma = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'cineon_gamma'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__jp2_flag

        public static final long[] __DNA__FIELD__jp2_flag
        Field descriptor (offset) for struct member 'jp2_flag'.

        Field Documentation

        Blender Source Code

        Jpeg2000

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__jp2_flag);
         CPointer<Byte> p_jp2_flag = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'jp2_flag'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__jp2_codec

        public static final long[] __DNA__FIELD__jp2_codec
        Field descriptor (offset) for struct member 'jp2_codec'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__jp2_codec);
         CPointer<Byte> p_jp2_codec = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'jp2_codec'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__tiff_codec

        public static final long[] __DNA__FIELD__tiff_codec
        Field descriptor (offset) for struct member 'tiff_codec'.

        Field Documentation

        Blender Source Code

        TIFF

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__tiff_codec);
         CPointer<Byte> p_tiff_codec = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'tiff_codec'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD___pad

        public static final long[] __DNA__FIELD___pad
        Field descriptor (offset) for struct member '_pad'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD___pad);
         CPointer<CArrayFacade<Byte>> p__pad = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad'
        • Signature: 'char[4]'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__views_format

        public static final long[] __DNA__FIELD__views_format
        Field descriptor (offset) for struct member 'views_format'.

        Field Documentation

        Blender Source Code

        Multiview

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__views_format);
         CPointer<Byte> p_views_format = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'views_format'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__stereo3d_format

        public static final long[] __DNA__FIELD__stereo3d_format
        Field descriptor (offset) for struct member 'stereo3d_format'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__stereo3d_format);
         CPointer<Stereo3dFormat> p_stereo3d_format = p.cast(new Class[]{Stereo3dFormat.class});
         

        Metadata

        • Field: 'stereo3d_format'
        • Signature: 'Stereo3dFormat'
        • Actual Size (32bit/64bit): 8/8
      • __DNA__FIELD__view_settings

        public static final long[] __DNA__FIELD__view_settings
        Field descriptor (offset) for struct member 'view_settings'.

        Field Documentation

        Blender Source Code

        color management

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__view_settings);
         CPointer<ColorManagedViewSettings> p_view_settings = p.cast(new Class[]{ColorManagedViewSettings.class});
         

        Metadata

        • Field: 'view_settings'
        • Signature: 'ColorManagedViewSettings'
        • Actual Size (32bit/64bit): 152/160
      • __DNA__FIELD__display_settings

        public static final long[] __DNA__FIELD__display_settings
        Field descriptor (offset) for struct member 'display_settings'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ImageFormatData imageformatdata = ...;
         CPointer<Object> p = imageformatdata.__dna__addressof(ImageFormatData.__DNA__FIELD__display_settings);
         CPointer<ColorManagedDisplaySettings> p_display_settings = p.cast(new Class[]{ColorManagedDisplaySettings.class});
         

        Metadata

        • Field: 'display_settings'
        • Signature: 'ColorManagedDisplaySettings'
        • Actual Size (32bit/64bit): 64/64
    • Constructor Detail

      • ImageFormatData

        public ImageFormatData​(long __address,
                               Block __block,
                               BlockTable __blockTable)
    • Method Detail

      • getImtype

        public byte getImtype()
                       throws java.io.IOException
        Get method for struct member 'imtype'.

        Field Documentation

        Blender Source Code

        R_IMF_IMTYPE_PNG, R_...

        Note

        Video types should only ever be set from this structure when used from RenderData .

        Video types should only ever be set from this structure when used from RenderData.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__imtype
      • setImtype

        public void setImtype​(byte imtype)
                       throws java.io.IOException
        Set method for struct member 'imtype'.

        Field Documentation

        Blender Source Code

        R_IMF_IMTYPE_PNG, R_...

        Note

        Video types should only ever be set from this structure when used from RenderData .

        Video types should only ever be set from this structure when used from RenderData.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__imtype
      • getDepth

        public byte getDepth()
                      throws java.io.IOException
        Get method for struct member 'depth'.

        Field Documentation

        Blender Source Code

        bits per channel, R_IMF_CHAN_DEPTH_8 -> 32, not a flag, only set 1 at a time.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__depth
      • setDepth

        public void setDepth​(byte depth)
                      throws java.io.IOException
        Set method for struct member 'depth'.

        Field Documentation

        Blender Source Code

        bits per channel, R_IMF_CHAN_DEPTH_8 -> 32, not a flag, only set 1 at a time.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__depth
      • getPlanes

        public byte getPlanes()
                       throws java.io.IOException
        Get method for struct member 'planes'.

        Field Documentation

        Blender Source Code

        R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__planes
      • setPlanes

        public void setPlanes​(byte planes)
                       throws java.io.IOException
        Set method for struct member 'planes'.

        Field Documentation

        Blender Source Code

        R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__planes
      • getFlag

        public byte getFlag()
                     throws java.io.IOException
        Get method for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Generic options for all image types, alpha zbuffer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(byte flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.

        Field Documentation

        Blender Source Code

        Generic options for all image types, alpha zbuffer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getQuality

        public byte getQuality()
                        throws java.io.IOException
        Get method for struct member 'quality'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: jpeg quality.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__quality
      • setQuality

        public void setQuality​(byte quality)
                        throws java.io.IOException
        Set method for struct member 'quality'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: jpeg quality.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__quality
      • getCompress

        public byte getCompress()
                         throws java.io.IOException
        Get method for struct member 'compress'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: png compression.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__compress
      • setCompress

        public void setCompress​(byte compress)
                         throws java.io.IOException
        Set method for struct member 'compress'.

        Field Documentation

        Blender Source Code

        (0 - 100), eg: png compression.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__compress
      • getExr_codec

        public byte getExr_codec()
                          throws java.io.IOException
        Get method for struct member 'exr_codec'.

        Field Documentation

        Blender Source Code

        format specific OpenEXR

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__exr_codec
      • setExr_codec

        public void setExr_codec​(byte exr_codec)
                          throws java.io.IOException
        Set method for struct member 'exr_codec'.

        Field Documentation

        Blender Source Code

        format specific OpenEXR

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__exr_codec
      • getCineon_flag

        public byte getCineon_flag()
                            throws java.io.IOException
        Get method for struct member 'cineon_flag'.

        Field Documentation

        Blender Source Code

        Cineon

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_flag
      • setCineon_flag

        public void setCineon_flag​(byte cineon_flag)
                            throws java.io.IOException
        Set method for struct member 'cineon_flag'.

        Field Documentation

        Blender Source Code

        Cineon

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_flag
      • getCineon_white

        public short getCineon_white()
                              throws java.io.IOException
        Get method for struct member 'cineon_white'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_white
      • setCineon_white

        public void setCineon_white​(short cineon_white)
                             throws java.io.IOException
        Set method for struct member 'cineon_white'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_white
      • getCineon_black

        public short getCineon_black()
                              throws java.io.IOException
        Get method for struct member 'cineon_black'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_black
      • setCineon_black

        public void setCineon_black​(short cineon_black)
                             throws java.io.IOException
        Set method for struct member 'cineon_black'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_black
      • getCineon_gamma

        public float getCineon_gamma()
                              throws java.io.IOException
        Get method for struct member 'cineon_gamma'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_gamma
      • setCineon_gamma

        public void setCineon_gamma​(float cineon_gamma)
                             throws java.io.IOException
        Set method for struct member 'cineon_gamma'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cineon_gamma
      • getJp2_flag

        public byte getJp2_flag()
                         throws java.io.IOException
        Get method for struct member 'jp2_flag'.

        Field Documentation

        Blender Source Code

        Jpeg2000

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__jp2_flag
      • setJp2_flag

        public void setJp2_flag​(byte jp2_flag)
                         throws java.io.IOException
        Set method for struct member 'jp2_flag'.

        Field Documentation

        Blender Source Code

        Jpeg2000

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__jp2_flag
      • getJp2_codec

        public byte getJp2_codec()
                          throws java.io.IOException
        Get method for struct member 'jp2_codec'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__jp2_codec
      • setJp2_codec

        public void setJp2_codec​(byte jp2_codec)
                          throws java.io.IOException
        Set method for struct member 'jp2_codec'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__jp2_codec
      • getTiff_codec

        public byte getTiff_codec()
                           throws java.io.IOException
        Get method for struct member 'tiff_codec'.

        Field Documentation

        Blender Source Code

        TIFF

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tiff_codec
      • setTiff_codec

        public void setTiff_codec​(byte tiff_codec)
                           throws java.io.IOException
        Set method for struct member 'tiff_codec'.

        Field Documentation

        Blender Source Code

        TIFF

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tiff_codec
      • get_pad

        public CArrayFacade<java.lang.Byte> get_pad()
                                             throws java.io.IOException
        Get method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • set_pad

        public void set_pad​(CArrayFacade<java.lang.Byte> _pad)
                     throws java.io.IOException
        Set method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • getViews_format

        public byte getViews_format()
                             throws java.io.IOException
        Get method for struct member 'views_format'.

        Field Documentation

        Blender Source Code

        Multiview

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__views_format
      • setViews_format

        public void setViews_format​(byte views_format)
                             throws java.io.IOException
        Set method for struct member 'views_format'.

        Field Documentation

        Blender Source Code

        Multiview

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__views_format
      • setStereo3d_format

        public void setStereo3d_format​(Stereo3dFormat stereo3d_format)
                                throws java.io.IOException
        Set method for struct member 'stereo3d_format'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__stereo3d_format
      • getView_settings

        public ColorManagedViewSettings getView_settings()
                                                  throws java.io.IOException
        Get method for struct member 'view_settings'.

        Field Documentation

        Blender Source Code

        color management

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view_settings
      • setView_settings

        public void setView_settings​(ColorManagedViewSettings view_settings)
                              throws java.io.IOException
        Set method for struct member 'view_settings'.

        Field Documentation

        Blender Source Code

        color management

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view_settings