Class ImageUser


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

    Class Documentation

    Blender Source Code

    ImageUser is in Texture, in Nodes, Background Image , Image Window, .... should be used in conjunction with an ID * to Image .

    • Field Detail

      • __DNA__SDNA_INDEX

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

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

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

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

        Field Documentation

        Blender Source Code

        To retrieve render result.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__scene);
         CPointer<CPointer<Scene>> p_scene = p.cast(new Class[]{CPointer.class, Scene.class});
         

        Metadata

        • Field: 'scene'
        • Signature: 'Scene*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__framenr

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

        Field Documentation

        Blender Source Code

        Movies, sequences: current to display.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__framenr);
         CPointer<Integer> p_framenr = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'framenr'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__frames

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

        Field Documentation

        Blender Source Code

        Total amount of frames to use.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__frames);
         CPointer<Integer> p_frames = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'frames'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__offset

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

        Field Documentation

        Blender Source Code

        Offset within movie, start frame in global time.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__offset);
         CPointer<Integer> p_offset = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'offset'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__sfra

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

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__sfra);
         CPointer<Integer> p_sfra = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'sfra'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__cycl

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

        Field Documentation

        Blender Source Code

        Cyclic flag.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__cycl);
         CPointer<Byte> p_cycl = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'cycl'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__multiview_eye

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

        Field Documentation

        Blender Source Code

        Multiview current eye - for internal use of drawing routines.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__multiview_eye);
         CPointer<Byte> p_multiview_eye = p.cast(new Class[]{Byte.class});
         

        Metadata

        • Field: 'multiview_eye'
        • Signature: 'char'
        • Actual Size (32bit/64bit): 1/1
      • __DNA__FIELD__pass

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

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__pass);
         CPointer<Short> p_pass = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'pass'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__tile

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

        Field Documentation

        Blender Python API

        Tile in tiled image

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__tile);
         CPointer<Integer> p_tile = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'tile'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__multi_index

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

        Field Documentation

        Blender Source Code

        Listbase indices, for menu browsing or retrieve buffer.

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__multi_index);
         CPointer<Short> p_multi_index = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'multi_index'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__view

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

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__view);
         CPointer<Short> p_view = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'view'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__layer

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

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__layer);
         CPointer<Short> p_layer = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'layer'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__flag

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

        Pointer Arithmetics

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

         ImageUser imageuser = ...;
         CPointer<Object> p = imageuser.__dna__addressof(ImageUser.__DNA__FIELD__flag);
         CPointer<Short> p_flag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
    • Constructor Detail

      • ImageUser

        public ImageUser​(long __address,
                         Block __block,
                         BlockTable __blockTable)
      • ImageUser

        protected ImageUser​(ImageUser that)
    • Method Detail

      • getScene

        public CPointer<Scene> getScene()
                                 throws java.io.IOException
        Get method for struct member 'scene'.

        Field Documentation

        Blender Source Code

        To retrieve render result.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__scene
      • setScene

        public void setScene​(CPointer<Scene> scene)
                      throws java.io.IOException
        Set method for struct member 'scene'.

        Field Documentation

        Blender Source Code

        To retrieve render result.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__scene
      • getFramenr

        public int getFramenr()
                       throws java.io.IOException
        Get method for struct member 'framenr'.

        Field Documentation

        Blender Source Code

        Movies, sequences: current to display.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__framenr
      • setFramenr

        public void setFramenr​(int framenr)
                        throws java.io.IOException
        Set method for struct member 'framenr'.

        Field Documentation

        Blender Source Code

        Movies, sequences: current to display.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__framenr
      • getFrames

        public int getFrames()
                      throws java.io.IOException
        Get method for struct member 'frames'.

        Field Documentation

        Blender Source Code

        Total amount of frames to use.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frames
      • setFrames

        public void setFrames​(int frames)
                       throws java.io.IOException
        Set method for struct member 'frames'.

        Field Documentation

        Blender Source Code

        Total amount of frames to use.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__frames
      • getOffset

        public int getOffset()
                      throws java.io.IOException
        Get method for struct member 'offset'.

        Field Documentation

        Blender Source Code

        Offset within movie, start frame in global time.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__offset
      • setOffset

        public void setOffset​(int offset)
                       throws java.io.IOException
        Set method for struct member 'offset'.

        Field Documentation

        Blender Source Code

        Offset within movie, start frame in global time.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__offset
      • getSfra

        public int getSfra()
                    throws java.io.IOException
        Get method for struct member 'sfra'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sfra
      • setSfra

        public void setSfra​(int sfra)
                     throws java.io.IOException
        Set method for struct member 'sfra'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sfra
      • getCycl

        public byte getCycl()
                     throws java.io.IOException
        Get method for struct member 'cycl'.

        Field Documentation

        Blender Source Code

        Cyclic flag.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cycl
      • setCycl

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

        Field Documentation

        Blender Source Code

        Cyclic flag.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__cycl
      • getMultiview_eye

        public byte getMultiview_eye()
                              throws java.io.IOException
        Get method for struct member 'multiview_eye'.

        Field Documentation

        Blender Source Code

        Multiview current eye - for internal use of drawing routines.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__multiview_eye
      • setMultiview_eye

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

        Field Documentation

        Blender Source Code

        Multiview current eye - for internal use of drawing routines.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__multiview_eye
      • getPass

        public short getPass()
                      throws java.io.IOException
        Get method for struct member 'pass'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__pass
      • setPass

        public void setPass​(short pass)
                     throws java.io.IOException
        Set method for struct member 'pass'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__pass
      • getTile

        public int getTile()
                    throws java.io.IOException
        Get method for struct member 'tile'.

        Field Documentation

        Blender Python API

        Tile in tiled image
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tile
      • setTile

        public void setTile​(int tile)
                     throws java.io.IOException
        Set method for struct member 'tile'.

        Field Documentation

        Blender Python API

        Tile in tiled image
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__tile
      • getMulti_index

        public short getMulti_index()
                             throws java.io.IOException
        Get method for struct member 'multi_index'.

        Field Documentation

        Blender Source Code

        Listbase indices, for menu browsing or retrieve buffer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__multi_index
      • setMulti_index

        public void setMulti_index​(short multi_index)
                            throws java.io.IOException
        Set method for struct member 'multi_index'.

        Field Documentation

        Blender Source Code

        Listbase indices, for menu browsing or retrieve buffer.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__multi_index
      • getView

        public short getView()
                      throws java.io.IOException
        Get method for struct member 'view'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view
      • setView

        public void setView​(short view)
                     throws java.io.IOException
        Set method for struct member 'view'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__view
      • getLayer

        public short getLayer()
                       throws java.io.IOException
        Get method for struct member 'layer'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layer
      • setLayer

        public void setLayer​(short layer)
                      throws java.io.IOException
        Set method for struct member 'layer'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__layer
      • getFlag

        public short getFlag()
                      throws java.io.IOException
        Get method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(short flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • __io__addressof

        public CPointer<ImageUser> __io__addressof()
        Instantiates a pointer on this instance.